Project Name: ABDM - Sandbox Test Designed by: NHA

Integration
Module Name: ABHA Creation and Test Designed date:
Verification
Release Version: Test Executed by:
Test Execution date:
Application/ System Name:

Base URL Value

V3 APIs (SBX) [Link]
V1 and V2 APIs [Link]
{{baseUri}} [Link]
V3 APIs (Prod) [Link]

Client ID and Client Secret

Prerequisites Postman and Postman Collection

Test Case Steps To Be Executed Suggestions for the Functional Tester

[Link] Function Applicable To Mandatory/ Optional Functionality Expected Result Status Remark V1 API's V2 API's V3 API's
(to be checked during functional testing) (By User or Functional Tester)
ABHA Creation Process
[Link] [Link] [Link]

ABHA Creation Through

1 All
Aadhaar OTP

1. v1/registration/aadhaar/generateOtp 1. v2/registration/aadhaar/generateOtp 1. v3/enrollment/request/otp

2. v1/registration/aadhaar/resendAadhaarOtp 2. v2/registration/aadhaar/resendAadhaarOtp 2. v3/enrollment/request/otp
3. v1/registration/aadhaar/verifyOTP 3. v2/registration/aadhaar/verifyOTP 3. v3/enrollment/enrol/byAadhaar
4. No APIs 4. v2/registration/aadhaar/checkAndGenerateMobileOTP 4. No APIs
5. v1/registration/aadhaar/generateMobileOTP 5. v2/registration/aadhaar/generateMobileOTP 5. v3/enrollment/request/otp
6. v1/registration/aadhaar/verifyMobileOTP 6. v2/registration/aadhaar/verifyMobileOTP 6. v3/enrollment/auth/byAbdm
7. No APIs 7. No APIs 7. v3/profile/account/request/emailVerificationLink
8. v1/registration/aadhaar/createHealthIdWithAadhaarOtp 8. v2/registration/aadhaar/createHealthIdByAdhaar 8. No APIs
The system must provide an option to create ABHA through Aadhaar
1.1 Mandatory Create ABHA Option User will have an option to create ABHA 9. v1/registration/aadhaar/createHealthIdWithPreVerified 9. No APIs 9. No APIs
OTP
10. {{baseUri}}/v1/phr/profile/link/profileDetails 10. No APIs 10. No APIs
11. {{baseUri}}/v1/phr/registration/phr/suggestion 11. No APIs 11. v3/enrollment/enrol/suggestion
12. {{baseUri}}/v1/search/existsByHealthId 12. v2/search/existsByHealthId 12. No APIs
13. {{baseUri}}/v1/phr/registration/hid/create-phr-address 13. No APIs 13. v3/enrollment/enrol/abha-address

1.2 Mandatory Consent collection The system must display the consent language/ disclaimer language 1. Read consent language User provides consent for sharing of Aadhaar details and creation of ABHA. Please refer the approved consent language.
and collect user's consent as per the ABDM published consent. 2. Agree to the consent language (through 'I agree' checkbox or any other form of signature)
Refer Cell No-: M14 System records user consent for compliance with Health Data Management
Policy.

1.3 Optional Suggestions:- The system should be able to provide the consent in languages other 1. Read consent language User provides consent for sharing of Aadhaar details and creation of ABHA.
Consent collection should be multilingual than English also 2. Agree to the consent language (through 'I agree' checkbox or any other form of signature)
System records user consent for compliance with Health Data Management
Policy.

1.4 Mandatory Aadhaar collection and Error Message System must allow the user to enter Aadhaar Number and the system 1. Enter Aadhaar number User is prompted to enter correct Aadhaar Number
will display an error message for invalid Aadhaar Number
In case user enters an invalid Aadhaar number (A valid Aadhaar is a 12-
digit number), the system shows an error message "Aadhaar Number is not
valid".

1.5 Mandatory Aadhaar OTP Collection User receives Aadhaar OTP and System must allow the user to enter 1. Receive OTP on mobile number registered with Aadhaar User will be able to enter a valid Aadhaar OTP (A valid Aadhaar OTP is a 6-
Aadhaar OTP. 2. Enter Aadhaar OTP digit number).
Example -
Modified text for the "Please enter 6 -digit OTP sent to Aadhaar linked
mobile number " step during the ABHA Creation workflow with “We just
sent an OTP on the Mobile Number *******XXXX linked with Aadhaar.
Enter the OTP below to proceed with ABHA creation".

1.6 Mandatory Resend OTP System may activate the Resend OTP button maximum 2 times after 1. Click on Resend OTP Button User will able to send OTP again and verify it
60 seconds 2. Receive OTP on mobile

1.7 Mandatory OTP based Aadhaar Authentication System must verify the OTP Click on verify button (For Resend and Send) System authenticates the user's Aadhaar through OTP

It is recommended that verify button be auto enabled In case of incorrect OTP, the system displays an error
In case of correct OTP, the system allows the user to proceed
1.8 Optional Communication Mobile Number verification-I 1. If communication mobile number is same as Aadhaar linked mobile This is applicable for testcase cell no -G20 , point no-1 Redirect to the ABHA creation screen.
number then it should directly go to ABHA creation screen .
1. System will check entered mobile is same as Aadhaar linked mobile number. If returns true then user will
2. Alternatively , Integrators may also prompt for OTP again from the directed to ABHA creation screen.
user and then post verification of OTP user can go to ABHA creation
screen.
Note: Many integrating entities have not 2. For point number 2 step are already mentioned in test case cell no- G20 , point no-2
implemented API for OTP not to be sent in case
communication mobile is same as Aadhaar linked
mobile. In that case the test scenario detailed
under sl. No 1.8 will only be considered. However,
it is recommended that API =
checkAndGenerateMobileOTP be implemented.
This will reduce one step of OTP verification in
1. System must verify the mobile number.
case communication mobile is same as the
If communication mobile number is not same as Aadhaar linked mobile 1. System must send OTP on mobile number
Aadhaar linked mobile
1.9 Mandatory Communication Mobile Number verification-II number then system must ask for the OTP to verify comuncation mobile 2. User enters the OTP and clicks on verify System verifies the communication mobile number
number. 3. In case of incorrect OTP, the system displays an error
4. In case of correct OTP, the system allows the user to proceed

1. The system should allow the user to select the ABHA address giving
atleast 3 available suggestions

2. Otherwise the system should have a provision to create a ABHA

address with ABHA address Policy and validation rule should be print
beside the field where ABHA Address is entered.
Mandatory for Private System should prompt / display the available or suggested ABHA addresses.
/Government (Optional 1. Governemnt integrator may use the option for creating default ABHA address. However, it is recommended that System should allow the user to proceed with the enterered ABHA Address.
Validation rules on ABHA Address to be set at the API level:
for integrated program user-defined or system suggested ABHA address be used In case, entered ABHA address is already in use then system should allow
1.1 Suggested ABHA Address 1. Minimum length - 8 characters
using demo auth as they 2. System should have a provision for private integrators to proceed with the suggested ABHA address. the user to input and proceed with any one of the suggested ABHA address.
2. Maximum length - 18 characters
have default ABHA 3. If beneficary use the existing ABHA address then system displays the "ABHA Address is already exist".
3. Special characters allowed - 1 dot (.) and/or 1 underscore (_)
address generated)
4. Special character dot and underscore should be in between. Special
characters cannot be in the beginning or at the end
5. Alphanumeric - only numbers, only letters or any combination of
numbers and letters is allowed.

1. System shows the 14-digit ABHA number and ABHA address generated User should be able to view the generated ABHA Number and linked ABHA
1.11 Mandatory Display of ABHA Number System must display the created ABHA Number
address

1. System should show the user their ABHA Card

2. ABHA Card should be generated by API and should contain -
a. ABHA Number (Mandatory)
View and Download ABHA details. User should be able to view their ABHA Card with all the demographc details
1.12 Mandatory for Private System must have a provision to View / Download ABHA card b. User Photo-Optional
(If integrators is generating ABHA card) as mentioned in cell H26
c. ABHA QR code
d. date of birth and gender
e. ABHA Address

Either of the test cases

CRT_ABHA_114 or
CRT_ABHA_115 is 1. If Integrator is not generating ABHA card then They print the mentioned information on their program/scheme or
System must have a provision to View details like ABHA number and User should be able to view card with ABHA number and ABHA address
mandatory for View and Download ABHA details. any other card
1.13 ABHA address in the card (either ABHA card or any card being and the details should be saved in HIMS system and linked with the HIMS
Governement (If integrators is not generating ABHA card) a. ABHA Number (Mandatory)
generated for their program/scheme/entity) unique beneficary 's ID.g or as per their business requirement.
b. ABHA Address

Optional for Private

ABHA Creation Through

2 All
Aadhaar Biometric

Create ABHA The system must provide an option to create ABHA through Aadhaar 1. v1/registration/aadhaar/verifyBio 1. No API 1. v3/enrollment/enrol/byAadhaar
2.1 Optional User will have a choice to create ABHA using Aadhaar Biometrics
Option Biometric
Please refer the approved consent language.
User provides consent for sharing of Aadhaar details and creation of ABHA.

The system must display the consent language/ disclaimer language 1. Read consent language System records user consent for compliance with Health Data Management
2.2 Optional Consent collection
and collect user's consent as per the ABDM published consent. 2. Agree to the consent language (through 'I agree' checkbox or any other form of signature) Policy.

Refer Cell No-: M14

User provides consent for sharing of Aadhaar details and creation of ABHA.

Suggestions:- The system should be able to provide the consent in languages other 1. Read consent language System records user consent for compliance with Health Data Management
2.3 Optional
Consent collection should be multilingual than English also 2. Agree to the consent language (through 'I agree' checkbox or any other form of signature) Policy.

User is prompted to enter correct Aadhaar Number

System must allow the user to enter Aadhaar Number and the system
2.4 Optional Aadhaar collection and Error Message 1. Enter Aadhaar number In case user enters an invalid Aadhaar number (A valid Aadhaar is a 12-
will display an error message for invalid Aadhaar Number
digit number), the system shows an error message "Aadhaar Number is not
valid".
System authenticates the user's Aadhaar though user's biometrics
1. Scan biometrics (Fingerprint)
2.5 Optional Biometric based Aadhaar Authentication System must verify the biometrics (fingerprint or face) of the user In case of incorrect biometrics, the system displays an error
2. Click on verify button
In case of correct biometrics, the system allows the user to proceed
This is applicable for testcase cell no -G20 , point no-1

Note: Many integrating entities have not 1. If communication mobile number is same as Aadhaar linked mobile 1. System will check entered mobile is same as Aadhaar linked mobile number. If returns true then user will
implemented API for OTP not to be sent in case number then it should directly go to ABHA creation screen . directed to ABHA creation screen.
2.6 communication mobile is same as Aadhaar linked Optional Communication Mobile Number verification-I Redirect to the ABHA creation screen.
mobile. In that case the test scenario detailed 2. Alternatively , Integrators may also prompt for OTP again from the
under sl. No 2.6 will only be considered. However, user and then post verification of OTP user can go to ABHA creation 2. For point number 2 step are already mentioned in test case cell no- G20 , point no-2
it is recommended that API = screen.
checkAndGenerateMobileOTP be implemented.
This will reduce one step of OTP verification in
1. System must verify the mobile number.
case communication mobile is same as the
If communication mobile number is not same as Aadhaar linked mobile 1. System must send OTP on mobile number
Aadhaar linked mobile
2.7 Optional Communication Mobile Number verification-II number then system must ask for the OTP to verify comuncation mobile 2. User enters the OTP and clicks on verify System verifies the communication mobile number
number. 3. In case of incorrect OTP, the system displays an error
4. In case of correct OTP, the system allows the user to proceed
1. System shows the 14-digit ABHA number and ABHA address generated
2.8 Optional Display of ABHA Number System must display the created ABHA Number User should be able to view the generated ABHA Number
1. System should show the user their ABHA Card
2. ABHA Card should be generated by API and should contain -
a. ABHA Number (Mandatory)
View and Download ABHA details.
2.9 Mandatory for Private System must have a provision to View / Download ABHA card b. User Photo-Optional User should be able to view their ABHA Card
(If integrators is generating ABHA card)
c. ABHA QR code
d. date of birth and gender
e. ABHA Address
 Either of the test cases
CRT_ABHA_209 or
CRT_ABHA_210 is 1. If Integrator is not generating ABHA card then They print the mentioned information on their program/scheme or
System must have a provision to View details like ABHA number and User should be able to view card with ABHA number and ABHA address
mandatory for View and Download ABHA details. any other card
2.1 ABHA address in the card (either ABHA card or any card being and the details should be saved in HIMS system and linked with the HIMS
Governement (If integrators is not generating ABHA card) a. ABHA Number (Mandatory)
generated for their program/scheme/entity) unique beneficary 's ID.g or as per their business requirement.
b. ABHA Address

Optional for Private

ABHA Creation Through
Demo Auth/ Offline Mode
3 (Available Only for trusted Government
entities. All government
Entities are eligible.
Create ABHA The system must provide an option to create ABHA through Aadhaar 1. v1/hid/benefit/createHealthId/demo/auth 1. v2/hid/benefit/createHealthId/demo/auth 1. v3/enrollment/enrol/byAadhaar
3.1 Mandatory
Option Demographic/ Offline Mode
Please refer the approved consent language.
User provides consent for sharing of Aadhaar details and creation of ABHA.

The system must display the consent language/ disclaimer language 1. Read consent language System records user consent for compliance with Health Data Management
3.2 Mandatory Consent collection
and collect user's consent as per the ABDM published consent. 2. Agree to the consent language (through 'I agree' checkbox or any other form of signature) Policy.

Refer Cell No-: M14

User provides consent for sharing of Aadhaar details and creation of ABHA.

Suggestions:- The system should be able to provide the consent in languages other 1. Read consent language System records user consent for compliance with Health Data Management
3.3 Optional
Consent collection should be multilingual than English also 2. Agree to the consent language (through 'I agree' checkbox or any other form of signature) Policy.

User is prompted to enter correct Aadhaar Number

System must allow the user to enter Aadhaar Number and the system
3.4 Mandatory Aadhaar collection and Error Message 1. Enter Aadhaar number In case user enters an invalid Aadhaar number (A valid Aadhaar is a 12-
will display an error message for invalid Aadhaar Number
digit number), the system shows an error message "Aadhaar Number is not
valid".

1. Enter beneficiary's name, date of birth, gender, Aadhaar Number, Mobile Number, Address, State name, and
district name in accordance with the details on their Aadhaar card.
2. Case 1:If the beneficiary has an existing ABHA address, it should be displayed on both the ABHA card and the
ABHA profile.
OR 1. System authenticates the user's Aadhaar though user's demographic
Case 2: If beneficary want to create a customize ABHA address then same ABHA address should be displayed on data.
System must verify the demographic information of the user against
3.5 Mandatory Demographic Information based authentication both the ABHA card and the ABHA profile. [Link] fields for name, date of birth, and gender are set as non-editable,
their Aadhaar
3 : Case 3 : If the beneficiary have no ABHA address then system will create a Default ABHA Address ( ABHA while the remaining fields can be open for editing i.e (Address, Email ,
Number @sbx) and same ABHA address should be displayed on both the ABHA card and the ABHA profile. Mobile Number, State, district , City e.t.c)
(Mandatory )
4. If a beneficiary's deatils are matched with Aadhaaar information then system will not allow to create ABHA.
5. If If a beneficiary's deatils are matched with Aadhaaar information then system will allow to create ABHA .

1. System auto-populates beneficiary's name, date of birth, gender, Aadhaar number, mobile number, address,
state name, district name
and ABHA Number.
[Link] fields for name, date of birth, and gender are set as non-editable, while the remaining fields can be open for
editing.

3.6 Mandatory Profile Completion System should accepts user's profile information -

1. The system displays the 14-digit ABHA number and generates the corresponding ABHA Address, adhering to the
3.7 Mandatory Display of ABHA Number System must display the created ABHA Number implementation chosen by integrators, either as a default setting or a customized one. User should be able to view the generated ABHA Number

1. System should show the user their ABHA Card

2. ABHA Card should be generated by API and should contain -
View and Download ABHA details. a. ABHA Number (Mandatory)
3.8 Mandatory for Private System must have a provision to View / Download ABHA card User should be able to view their ABHA Card
(If integrators is generating ABHA card) b. ABHA QR code
c. Name, date of birth and gender
d. ABHA Address

Either of the test cases

CRT_ABHA_308 or
CRT_ABHA_309 is 1. If Integrator is not generating ABHA card then They print the mentioned information on their program/scheme or
System must have a provision to View details like ABHA number and User should be able to view card with ABHA number and ABHA
mandatory for View and Download ABHA details. any other card with the beneficiary's demographic details.
3.9 ABHA address in the card (either ABHA card or any card being [Link] the details should be saved in HIMS system and linked with
Governement (If integrators is not generating ABHA card) a. ABHA Number (Mandatory)
generated for their program/scheme/entity) the HIMS unique beneficary 's ID.g or as per their business requirement.
b. ABHA Address

Optional for Private

Optional for Private

ABHA Creation Through
4
Driving License / PAN
Mandatory for Government
No APIs 1. v2/document/generate/mobile/otp 1. v3/enrollment/request/otp
4.1 Optional Create ABHA Option The system must provide an option to create ABHA through Driving License / PAN User will have a choice to create ABHA using Aadhaar Biometrics
2. v2/document/verify/mobile/otp 2. v3/enrollment/auth/byAbdm
User provides consent for sharing of Aadhaar details and creation of ABHA. Please refer the approved consent language. 3. v2/document/validate 3. v3/enrollment/enrol/byDocument
The System must display the consent/ disclaimer language and collect user's 1. Read the consent language
4.2 Optional Consent Collection
consent 2. Agree to the consent language (through 'I agree' checkbox or any other form of signature)
System records user consent for compliance with Health Data Management Policy.
4.3 Optional Communication Mobile Number System must collect the communication mobile number 1. Enters a valid mobile number for communication purpose User will be able to enter their Mobile Number
1. Receive OTP on mobile number In case of incorrect OTP, the system displays an error
4.4 Optional Mobile Number Verification System must verify the provided mobile number
2. Enter the OTP and clicks on verify In case of correct OTP, the system allows the user to proceed
System must verify the provided document - Driving License / PAN 1. Enter the Driving License / PAN number
2. Enter name, date of birth and gender as per the document.
4.5 Optional Document Verification System validates user's Driving License / PAN
3. successfully verification will generate enrollment number
4. With this enrollment number patient/ user will approach with any ABDM facilty for creation of ABHA number .

4.6 Optional Document Upload System must allow upload of front and back page of the Driving licence/ PAN 1. Upload the front and back page of the document i.e Driving License / PAN. Document photos are uploaded in the system

Documents are manually verified.

System Operator / healthcare worker must manually check the documents - Driving
4.7 Optional Manual Verification and ABHA Creation 1. A healthcare worker/ system operator manually verifies the Driving License / PAN In case the document is valid, the operator approves ABHA creation.
License / PAN
In case the document is invalid, the operator rejects the ABHA creation.
1. Show the 14-digit ABHA number generated
4.8 Optional Display of ABHA Number System should display the created ABHA Number User should be able to view the generated ABHA Number
2. Show ABHA Number instead of Health ID
1. System should show the user their ABHA Card
2. ABHA Card should be generated by API and should contain -
a. ABHA Number (Mandatory) User should be able to view their ABHA Card and the details should be
View and Download ABHA details.
4.9 Optional System must have a provision to View / Download ABHA card b. User Photo-Optional saved in HIMS system and linked with the HIMS unique beneficary 's ID.g
(If integrators is generating ABHA card)
c. ABHA QR code or as per their business requirement.
d. date of birth and gender
e. ABHA Address
1. If Integrator is not generating ABHA card then They print the mentioned information on their own card.
View and Download ABHA details.
4.1 Optional If Integrator is not generating ABHA card. a. ABHA Number (Mandatory) User should be able to view card with ABHA number and ABHA address.
(If integrators is not generating ABHA card)
b. ABHA Address
ABHA Verification Process
5 ABHA Verification All

1. In case of correct OTP, the verification is complete and the System can 1. v1/auth/init 1. v2/auth/init 1. v3/profile/login/request/otp
fetch user's ABHA profile - name, date of birth, gender, mobile number, 2. v1/auth/confirmWithAadhaarOtp 2. v2/auth/confirmWithAadhaarOtp 2. v3/profile/login/verify
photo and address, ABHA Number , ABHA Address and other details from 3. v3/profile/account
1. Share ABHA Number or ABHA Address the APIs.
4. v3/profile/account/abha-card
2. Receive OTP on the Aadhaar linked mobile number 2. In case of incorrect OTP, the verification fails.
3. Enter the OTP.
5.1 Mandatory ABHA Number Verification using Aadhaar OTP System must allow ABHA Number verification using Aadhaar OTP 4. System may activate the Resend OTP button maximum 2 times after 60 seconds in the OTP not received. 3. The fields for name, date of birth, and gender are set as non-editable,
5. If beneficiary updates their mobile number in the HIMS system and It is advisable to provide users with the while the remaining fields can be open for editing i.e (Address, Email ,
option to update their mobile number in the ABHA profile with (Yes/No) using the profile API you should be able to Mobile Number, State, district , City e.t.c)
update the details.
4. After verification , the details should be saved in HIMS system and linked
with the HIMS unique beneficary 's ID.g or as per their business
requirement.
1. v1/phr/search/authMethods?phrAddress=singh128@sbx No APIs 1. v3/phr/web/login/abha/search
2. v1/auth/init 2. v3/phr/web/login/abha/request/otp
3. v1/auth/confirmWithAadhaarOTP 3. v3/phr/web/login/abha/verify
4. v3/phr/web/login/profile/abha-profile
1. In case of correct OTP, the verification is complete and the System can 5. v3/phr/web/login/profile/abha/phr-card
fetch user's ABHA profile - name, date of birth, gender, mobile number,
photo and address, , state,district, ABHA Number , ABHA Address and other
details from the APIs.
1. Share ABHA Number or ABHA Address.
2. Receive OTP on the Aadhaar linked mobile number.
2. In case of incorrect OTP, the verification fails.
3. Enter the OTP.
5.2 Mandatory ABHA Address Verification using Aadhaar OTP System must allow ABHA Address verification using Aadhaar OTP 4. System may activate the Resend OTP button maximum 2 times after 60 seconds in the OTP not received.
3. The fields for name, date of birth, and gender are set as non-editable,
5. If beneficiary updates their mobile number in the HIMS system and It is advisable to provide users with the
while the remaining fields can be open for editing i.e (Address, Email ,
option to update their mobile number in the ABHA profile with (Yes/No) using the profile API you should be able to
Mobile Number, State, district , City e.t.c)
update the details.
4. After verification , the details should be saved in HIMS system and linked
with the HIMS unique beneficary 's ID.g or as per their business
requirement.

6 ABHA Verification All

1. In case of correct OTP, the verification is complete and the System can 1. v1/auth/init 1. v2/auth/init 1. v3/profile/login/request/otp
fetch user's ABHA profile - name, date of birth, gender, mobile number, 2. v1/auth/confirmWithMobileOTP 2. v2/auth/confirmWithMobileOTP 2. v3/profile/login/verify
photo and address, , state,district,ABHA Number , ABHA Address and other 3. v3/profile/account
details from the APIs. 4. v3/profile/account/abha-card
[Link] case of incorrect OTP, the verification fails.

2. The fields for name, date of birth, and gender are set as non-editable,
1. Share ABHA Number or ABHA Address while the remaining fields can be open for editing i.e (Address, Email ,
2. Receive OTP on the Communication mobile number Mobile Number, State, district , City e.t.c)
3. Enter the OTP.
ABHA Number verification using mobile OTP(ABHA System must allow ABHA Number verification using
Mandatory 4. System may activate the Resend OTP button maximum 2 times after 60 seconds in the OTP not received. 4. After verification , the details should be saved in HIMS system and linked
Linked Mobile Number ) mobile OTP(ABHA Linked Mobile Number )
5. If beneficiary updates their mobile number in the HIMS system and It is advisable to provide users with the with the HIMS unique beneficary 's ID.
option to update their mobile number in the ABHA profile with (Yes/No) using the profile API you should be able to
update the details.
 1. v1/phr/search/authMethods?phrAddress=singh128 No APIs 1. v3/phr/web/login/abha/search
1. In case of correct OTP, the verification is complete and the System can 2. v1/auth/init 2. v3/phr/web/login/abha/request/otp
fetch user's ABHA profile - name, date of birth, gender, mobile number, 3. v1/auth/confirmWithMobileOTP 3. v3/phr/web/login/abha/verify
photo and address,, state,district, ABHA Number , ABHA Address and other 4. v3/phr/web/login/profile/abha-profile
details from the APIs. 5. v3/phr/web/login/profile/abha/phr-card
1. Share ABHA Number or ABHA Address
2. Receive OTP on the Communication mobile number 2. In case of incorrect OTP, the verification fails.
3. Enter the OTP.
ABHA Address verification using mobile OTP(ABHA System must allow ABHA Address verification using
6.1 Mandatory 4. System may activate the Resend OTP button maximum 2 times after 60 seconds in the OTP not received. 3. The fields for name, date of birth, and gender are set as non-editable,
Linked Mobile Number ) mobile OTP(ABHA Linked Mobile Number )
5. If beneficiary updates their mobile number in the HIMS system and It is advisable to provide users with the while the remaining fields can be open for editing i.e (Address, Email ,
option to update their mobile number in the ABHA profile with (Yes/No) using the profile API you should be able to Mobile Number, State, district , City e.t.c)
update the details.
4. After verification , the details should be saved in HIMS system and linked
with the HIMS unique beneficary 's ID.g or as per their business
requirement.

7 ABHA Verification All

7.1 Fetch ABHA details using Mobile System must allow ABHA retrieval using communication mobile OTP 1. If the user enters a in-valid mobile number(communication) then system will display an error message " Please Display relevant error messgae. No APIs 1. v2/registration/mobile/login/generateOtp 1. v3/profile/login/request/otp
(communication)authentication . enter a valid mobile number". 2. v2/registration/mobile/login/verifyOtp 2. v3/profile/login/verify
Mandatory Multi authentication feature also need to be 3. v2/registration/mobile/login/userAuthorizedToken 3. v3/profile/login/verify/user
implemented like Captcha preferred 4. v3/profile/account
5. v3/profile/account/abha-card

7.2 ABHA Details not exists to communicated Mobile Number 1. Incase ABHA Details not exists to communicated Mobile Number in ABHA system. System will display an error message i.e.
" ABHA Number not found
Mandatory We did not find any ABHA number linked to this mobile number.
Please use ABHA linked mobile number"
Kindly Note: System should allow to create ABHA option should be
open.
7.3 ABHA Details exists to communicated Mobile Number. 1. Incase ABHA Details exists to communicated Mobile Number. 1. Fetching ABHA Details.
1.1. If ABHA Details exists to comunication mobile number exists in ABHA system , In case ' Yes' then system 2. Register and Linked in their HIMS OR OR benefciary can download the
Mandatory will display a message "ABHA Exists to communication Mobile" and user will receive the OTP i.e "OTP sent to ABHA ABHA card.
linked mobile number ending with ******XXXX" and then Upon verification completion, the system will display a
list of ABHA numbers linked to the mobile number, including the following details: Name, ABHA Number, ABHA
Address, and the beneficiary's photograph. When the user attempts to link selected ABHA details, the system will
verify if the selected record is present in the HIMS system. If so, it will display a message indicating that the record
is already linked in the HIMS with the HIMS beneficiary's ID.
1.2 If the selected ABHA Profile is not present in HIMS, the system will allow it to be Register and linked in
their HIMS beneficary's ID or proceed as per bussiness requirement OR benefciary can download the ABHA card
(Optional)

7.4 Incorrect OTP 1. In case of incorrect OTP, the verification fails and display the relevant message. Display relevant error messgae.

Mandatory
7.5 Resend OTP Functionality 1. System may activate the Resend OTP button maximum 2 times after 60 seconds in the OTP not received.

Mandatory
Fetching ABHA details
8 using Aadhaar Number All

8.1 Fetch ABHA details using Aadhaar Number System must allow ABHA retrieval using Aadhaar Number [Link] the user enters wrong Aadhaar Number then system will display an error message "Invalid LoginId" or some Display relevant error messgae. No APIs No APIs 1. v3/profile/login/request/otp
relevant message i.e "Aadhaar Number is not valid". 2. v3/profile/login/verify
Mandatory

Mandatory Incorrect OTP 1. In case of incorrect OTP, the verification fails and display the relevant message. Display relevant error messgae.
8.2 ABHA Details not exists to Aadhaar Number 1. Beneficary enter Aadhaar Number . Display relevant error messgae.
2. Beneficary will receive the OTP i.e "OTP sent to Aadhaar linked mobile number ending with ******XXXX"
3. After OTP verfication then system will display "NO ABHA user registered with this Aadhaar Number".
Mandatory
4. The system should have a provision to create ABHA.

8.3 ABHA Details exists to Aadhaar Number 1. Enter Aadhaar Number. 1. Display ABHA Profile details.
2. Beneficary will receive the OTP i.e "OTP sent to Aadhaar linked mobile number ending with ******XXXX" . 2. Download ABHA Card.
3. After the OTP verfication. If ABHA Number exists then system will display Beneficary ABHA profile details and 3. Register and linked in their HIMS beneficary's ID or proceed as per
Mandatory user can download the ABHA card. bussiness requirement .
4. If ABHA Profile is not present in HIMS, the system will allow it to be Register and linked in their HIMS
beneficary's ID or proceed as per bussiness requirement .

8.4 Resend OTP Functionality 1. System may activate the Resend OTP button maximum 2 times after 60 seconds in the OTP not received. Display relevant error messgae.
Mandatory
ABHA Verification
9 (Applicable for All
Government Entites)
In case the biometrics match, the verification is complete and the System 1. v1/auth/init 1. v2/auth/init No APIs
can fetch user's ABHA profile - name, date of birth, gender, mobile number, 2. v1/auth/confirmWithAadhaarBio 2. v2/auth/confirmWithAadhaarBio
ABHA Number verification using Aadhaar Biometric - 1. Share ABHA Number or ABHA Address photo and address, ABHA Number , ABHA Address and other details from
9.1 Optional System must allow ABHA Number verification using Biometric scan
Fingerprint 2. Scan fingerprint or face the APIs.

In case the biometrics do not match, the verification fails.

In case the biometrics match, the verification is complete and the System No APIs No APIs No APIs
can fetch user's ABHA profile - name, date of birth, gender, mobile number,
ABHA Address verification using Aadhaar Biometric - 1. Share ABHA Number or ABHA Address photo and address, ABHA Number , ABHA Address and other details from
9.2 Optional System must allow ABHA Address verification using Biometric scan
Fingerprint 2. Scan fingerprint or face the APIs.

In case the biometrics do not match, the verification fails.

Reading ABHA Info using
10 All
ABHA QR Code
1. v1/account/qrCode 1. v2/account/qrCode 1. v3/profile/account/qrCode
System must allow scanning of ABHA QR code to read the ABHA System reads the user information from the ABHA QR code - name, date of
10.1 Optional Reading ABHA Profile Info using ABHA QR Code 1. EMR/HMIS scans the user's ABHA QR code
information birth, gender, mobile and other details into the system for registration.
11 Profile Update All
1. Enter new mobile number No APIs 1. v2/account/change/mobile/new/generateOTP 1. v3/profile/account/request/otp
11.1 Optional Mobile Update System must allow the user to update their Mobile number 2. Enter OTP Mobile number on ABHA profile is updated 2. v2/account/change/mobile/new/verifyOTP 2. v3/profile/account/verify
3. Enter Password/ OTP on old mobile number
1. Click on Edit Photo 1. v1/account/profile 1. v2/account/profile 1. v3/profile/account
11.2 Optional Photo Update System must allow the user to update their Photo Photo on ABHA profile is updated
2. Upload new photo
1. Enter new Email ID No APIs 1. v2/account/email/verification/send/otp 1. v3/profile/account/request/otp
11.3 Optional Email Update System must allow the user to update their Email Email ID on ABHA profile is updated
2. Enter OTP 2. v2/account/email/verification/verify/otp 2. v3/profile/account/verify
1. Click on re-KYC option No APIs 1. v2/account/aadhaar/generateOTP 1. v3/profile/account/request/otp
11.4 Optional Re-KYC System must allow the user to perform re-KYC KYC details on ABHA profile are updated
2. Enter OTP received on Aadhaar linked mobile numer 2. v2/account/aadhaar/verifyOTP 2. v3/profile/account/verify
No APIs
Delete using Aadhaar OTP OR ABDM OTP Delete using Aadhaar OTP OR ABDM OTP
1. v2/account/aadhaar/generateOTP 1. v3/profile/account/request/otp
2. v2/account/profile/delete 2. v3/profile/account/verify

Deactivate using Aadhaar OTP OR ABDM OTP Deactivate using Aadhaar OTP OR ABDM OTP
1. Click on Delete/ Deactivate ABHA ABHA Number should be deleted.
11.5 Optional Delete ABHA System must allow the user to Delete/ Deactivate ABHA 2. Enter OTP received on mobile number to confirm deletion/ deactivation
3. Try to login again using the same ABHA The system should not allow login through the same ABHA 1. v2/account/aadhaar/generateOTP 1. v3/profile/account/request/otp
2. v2/account/profile/delete 2. v3/profile/account/verify

Re-activate using Aadhaar OTP OR ABDM OTP Re-activate using Aadhaar OTP OR ABDM OTP

1. v2/auth/reactivate/init 1. v3/profile/login/request/otp
2. v2/auth/reactivate 2. v3/profile/login/verify/user
Verify one ABHA Number is
16 linked to the unique patient All
ID in HIMS
16 ABHA Number should be validated in the database if already exists before creating a new patient id to avoid tagging No APIs No APIs No APIs
of multiple patient id with same ABHA Number.
Verify one ABHA Number is linked to the unique Intergrator's HIMS System should allow tagging of one ABHA Number
Mandatory Kindly Note: This test scenario is applicable for both new and existing beneficiaries and linking will be happens with HIMS is able to tag Patient ID with ABHA number.
patient ID in HIMS with unique patient Id.
ABHA creation and verification flow.

17 Share Profile PHR app Mandatory

/v1/patients/profile/share /v1/patients/profile/share [Link]
1. Log into PHR app. /v0.5/patients/profile/on-share /v0.5/patients/profile/on-share [Link]
1. Log into PHR app. 2. User will scan the QR code which is placed at the facility premises/registration desk.
2. User will scan the QR code which is placed at the facility premises/registration desk. 3. Post scanning, patient profile details are displayed including ABHA number, ABHA
3. Post scanning, patient profile details are displayed including ABHA number, ABHA address, Name, Gender, DoB, Mobile No and address, Name, Gender, DoB, Mobile No and Address. Below this consent language is
Address. Below this consent language is displayed - "Your consent to the above information to be shared with <HIP Name>. They displayed - "Your consent to the above information to be shared with <HIP Name>.
17.1 Mandatory Share Patient Profile User will scan the QR code which is placed the facility premises can use this information for your registration and linking your health records" and both "Cancel" / "Share" buttons are provided. They can use this information for your registration and linking your health records"
[Link] that after clicking on "Share" button, user profile is successfully shared with the HIP and if user click on "Cancel" button and both "Cancel" / "Share" buttons are provided.
then user profile is not shared with the HIP. [Link] that after clicking on "Share" button, user profile is successfully shared with
5. User clicks on share and gets a token number. the HIP and if user click on "Cancel" button then user profile is not shared with the HIP.
6. User clicks on ok and gets token number with validity of 30 minutes. 5. User clicks on share and gets a token number.
6. User clicks on ok and gets token number with validity of 30 minutes.

18 Login via Password

Login via password 1. v1/auth/authPassword 1. v2/auth/authPassword 1. v3/profile/login/verify
19 Forgot ABHA
19.1 Via Aadhaar OTP No APIs 1. v2/auth/reactivate/init 1. v3/profile/login/request/otp
2. v2/auth/reactivate 2. v3/profile/login/verify
19.2 Via Mobile OTP No APIs 1. v2/auth/reactivate/init 1. v3/profile/login/request/otp
2. v2/auth/reactivate 2. v3/profile/login/verify
20 Set / Update Password
20.1 Set Password 1. v1/account/change/passwd/byAadhaar 1. v2/account/change/passwd/byAadhaar 1. v3/profile/account/verify
20.2 Update Password Via Aadhaar Otp 1. v1/account/change/passwd/generateAadhaarOTP 1. v2/account/change/passwd/generateAadhaarOTP 1. v3/profile/account/request/otp
2. v1/account/change/passwd/byAadhaar 2. v2/account/change/passwd/byAadhaar 2. v3/profile/account/verify
20.3 Update Password Via Password 1. v1/account/change/password 1. v2/account/change/password 1. v3/profile/account/verify
Update Password Via Mobile Otp 1. v1/account/change/passwd/generateMobileOTP 1. v2/account/change/passwd/generateMobileOTP 1. v3/profile/account/request/otp
20.3 2. v1/account/change/passwd/byMobile 2. v2/account/change/passwd/byMobile 2. v3/profile/account/verify
21 Benefit API's
1. v1/hid/benefit/aadhaar/generateOtp 1. v2/hid/benefit/aadhaar/generateOtp 1. v3/enrollment/request/otp
21.1 Create ABHA using Aadhaar
2. v1/hid/benefit/aadhaar/verifyAadharOtp 2. v2/hid/benefit/aadhaar/verifyAadharOtp 2. v3/enrollment/enrol/byAadhaar
21.2 Create ABHA using Aadhaar Bio 1. v1/registration/aadhaar/verifyBio 1. v2/registration/aadhaar/verifyBio 1. v3/enrollment/enrol/byAadhaar
22 Benefit Link Delink ABHA
22.1 Link ABHA With Benefit Name 1. v1/hid/benefit/link 1. v2/hid/benefit/link 1. v3/profile/benefit/linkAndDelink
22.2 De-link ABHA With Benefit Name 1. v1/hid/benefit/deLinkHid 1. v2/hid/benefit/deLinkHid 1. v3/profile/benefit/linkAndDelink
Benefit Update ABHA
23
Profile Details
23.1 Update Mobile Number 1. v1/hid/benefit/update/mobile 1. v2/hid/benefit/update/mobile 1. v3/profile/account
23.2 Update Profile 1. v1/hid/benefit/update/profile 1. v2/hid/benefit/update/profile 1. v3/profile/account
2. v1/hid/benefit/update/status 2. v2/hid/benefit/update/status 2. No API
24 Search Benefit Details
24.1 Search by xmlUid 1. v1/hid/benefit/search/aadhaar 1. v2/hid/benefit/search/aadhaar 1. v3/profile/benefit/search
24.2 Search by Health Id Number 1. v1/hid/benefit/search/healthIdNumber 1. v2/hid/benefit/search/healthIdNumber 1. v3/profile/benefit/abha/healthIdNumber
24.3 Search 1. No API 1. No API 1. v3/profile/benefit/abha/{{healthIdNumber}}
25 Find ABHA via Mobile
No APIs No APIs 1. v3/profile/account/abha/search
Find ABHA using Mobile number 2. v3/profile/login/request/otp
3. v3/profile/login/verify
26 Child ABHA
No APIs 1. v2/hid/benefit/integrator/child/createHealthId 1. v3/enrollment/enrol/byAadhaar
Create child ABHA 2. v2/hid/benefit/integrator/child/parent/mappedAbhaId 2. v3/enrollment/profile/children
3. v2/account/profile 3. v3/profile/account
27 ABHA Address Creation
1. v1/registration/mobile/generateOtp No APIs 1. v3/phr/web/enrollment/abha/request/otp
2. v1/registration/mobile/verifyOtp 2. v3/phr/web/enrollment/abha/verify
27.1 ABHA address creation via mobile 3. No API 3. v3/phr/web/login/abha/verify/user
4. v1/phr/registration/phr/suggestion 4. v3/phr/web/enrollment/suggestion
5. v1/search/existsByHealthId 5. v3/phr/web/enrollment/isExists?abhaAddress=dharam123@sbx
6. v1/phr/registration/create/phr 6. v3/phr/web/enrollment/abha/enrol
27.2 Get ABHA address 1. v1/account/profile 1. v2/account/profile 1. v3/phr/web/login/profile/abha-profile
2. v1/account/getPngCard 2. v2/account/getPngCard 2. v3/phr/web/login/profile/abha/phr-card
28 Logout
Profile logout 1. v1/account/logout 1. v2/account/logout 1. v3/profile/account/request/logout

For teams utilizing APIs from version 1 (v1) or version 2 (v2), this document provides comprehensive mapping to the version 3 (v3) APIs. Although we have consistently referenced version 2 (v2) throughout this document, the
guidance and mappings provided are equally applicable to version 1 (v1) APIs.
Note:
This ensures that regardless of the API version currently in use, teams can seamlessly transition to the updated v3 APIs by referring to the detailed mappings and representations included herein.
Please utilize this document as a primary resource for understanding the changes and enhancements in v3, and for ensuring compatibility with your existing API implementations.