​
ABHA Address

An ABHA Address is a memorable username that allows users to access and manage their health records digitally and share them with various healthcare providers. It follows the format sudev@abdm and is essential identifier for all ABDM transactions.

​
ABHA Number

The ABHA Number is a unique 14-digit identifier issued after a thorough KYC process. Multiple ABHA Address can be attached to a ABHA Number.

​
Creating an ABHA Number with Aadhaar

ABHA Numbers can be generated by authenticating with Aadhaar. Aadhaar serves as the KYC here.
1

Enter the Aadhaar Number

Use the Initiate Aadhaar Registration endpoint to start the Aadhaar registration process.
2

Verify Aadhaar OTP

Use the Verify Aadhaar OTP endpoint to verify the OTP generated for Aadhaar registration.
3

Verify Mobile Number (Optional)

If the mobile number provided in the second step differs from the one linked to Aadhaar, use the Verify New Mobile Number endpoint to verify the new mobile number.
4

Create ABHA Address

Use the Create ABHA Address endpoint to generate a new ABHA address.

​
Creating ABHA Address using Mobile

1

Enter Mobile Number

Use the Initiate Mobile Registration endpoint to start the registration process for a mobile number.
2

Verify Mobile OTP

Use the Verify Mobile OTP endpoint to verify the OTP sent to the mobile number.The response from the verification will include the user’s existing ABHA Address associated with the mobile number. In the next step, the user can either create a new ABHA Address or log in to the existing ABHA Address.
3

Create ABHA Address

​
Logging into ABHA Address

1

Initiate Login

Use the Login Initiation endpoint to start the login process by entering the mobile number.
2

Verify Login OTP

Use the Verify Login OTP endpoint to verify the OTP sent to the registered mobile number.After successful verification, the response will include the user’s existing ABHA Address associated with the mobile number.If the method in the Login init API is set to “abha_address”, then this API itself will complete the login process, and no further API call is required.
3

Login to ABHA Address

Use the Login endpoint to authenticate and access the ABHA Address.

​
Skip State Enum

The Skip State Enum in the API response determines the next screen the user should see:
  • abha_end – This state indicates that the ABHA registration or login process is complete, and no further action is needed.
  • confirm_mobile_otp – This occurs when a user verifies their Aadhaar OTP but enters a mobile number that is not linked to their Aadhaar. In this case, the user should be taken to the mobile verification page.
  • abha_select – If the state is abha_select, the user should be taken to the login page, where they have multiple ABHA addresses. They can choose one to proceed with the login.
  • abha_create – This indicates that no ABHA address has been created yet, so the user should be directed to the ABHA creation page.