M1 ABHA CREATION AND VERIFICATION WITH APIS UPDATED V1 1 f656c93440
M1 ABHA CREATION AND VERIFICATION WITH APIS UPDATED V1 1 f656c93440
Integration
Module Name: ABHA Creation and
Verification
Release Version:
1.1 Mandatory
1.2 Mandatory
1.3 Optional
1.4 Mandatory
1.5 Mandatory
1.6 Mandatory
1.7 Mandatory
1.11 Mandatory
2.1 Optional
2.2 Optional
2.3 Optional
2.4 Optional
2.5 Optional
sent in case
communication
mobile is same as
Aadhaar linked
mobile. In that case
2.6 the test scenario Optional
detailed under sl.
No 2.6 will only be
considered.
However, it is
recommended that
API =
API =
checkAndGenerate
MobileOTP be
2.7 Optional
implemented. This
will reduce one step
of OTP verification
2.8 Optional
3.1 Mandatory
3.2 Mandatory
3.3 Optional
3.4 Mandatory
3.5 Mandatory
3.6 Mandatory
3.7 Mandatory
3.8 Mandatory for Private
4.1 Optional
4.2 Optional
4.3 Optional
4.4 Optional
4.5 Optional
4.6 Optional
4.7 Optional
4.8 Optional
4.9 Optional
4.1 Optional
5.1 Mandatory
5.2 Mandatory
6.1 Mandatory
Mandatory
7.2
Mandatory
7.3
Mandatory
7.4
Mandatory
7.5
Mandatory
Fetching ABHA details
8 using Aadhaar Number All
8.1
Mandatory
Mandatory
8.2
Mandatory
8.3
Mandatory
8.4
Mandatory
ABHA Verification
9 (Applicable for Government All
Entites)
9.1 Optional
9.2 Optional
10.1 Optional
11.1 Optional
11.2 Optional
11.3 Optional
11.4 Optional
11.5 Optional
16
Mandatory
https://dev.abdm.gov.in/api/hiecm/gateway/v3/sessions
Create ABHA
CRT_ABHA_201
Option
Suggestions:-
CRT_ABHA_203
Consent collection should be multilingual
Create ABHA
CRT_ABHA_301
Option
Suggestions:-
CRT_ABHA_303
Consent collection should be multilingual
CRT_ABHA_304 Aadhaar collection and Error Message
VRFY_ABHA _304
VRFY_ABHA _305
VRFY_ABHA_402
VRFY_ABHA_403
VRFY_ABHA_404
VRFY_ABHA_405
PROF_ABHA_604 Re-KYC
Test Case
(to be checked during functional testing)
The system must provide an option to create ABHA through Aadhaar OTP
The system must display the consent language/ disclaimer language and
collect user's consent as per the ABDM published consent.
Refer Cell No-: M14
The system should be able to provide the consent in languages other
than English also
System must allow the user to enter Aadhaar Number and the system
will display an error message for invalid Aadhaar Number
User receives Aadhaar OTP and System must allow the user to enter
Aadhaar OTP.
System may activate the Resend OTP button maximum 2 times after 60
seconds
2. Alternatively , Integrators may also prompt for OTP again from the
user and then post verification of OTP user can go to ABHA creation
screen.
If communication mobile number is not same as Aadhaar linked mobile
number then system must ask for the OTP to verify comuncation mobile
number.
1. The system should allow the user to select the ABHA address giving
atleast 3 available suggestions
The system must display the consent language/ disclaimer language and
collect user's consent as per the ABDM published consent.
System must allow the user to enter Aadhaar Number and the system
will display an error message for invalid Aadhaar Number
2. Alternatively , Integrators may also prompt for OTP again from the
user and then post verification of OTP user can go to ABHA creation
screen.
If communication mobile number is not same as Aadhaar linked mobile
number then system must ask for the OTP to verify comuncation mobile
number.
System must have a provision to View details like ABHA number and
ABHA address in the card (either ABHA card or any card being generated
for their program/scheme/entity)
The system must display the consent language/ disclaimer language and
collect user's consent as per the ABDM published consent.
System must have a provision to View details like ABHA number and
ABHA address in the card (either ABHA card or any card being generated
for their program/scheme/entity)
The system must provide an option to create ABHA through Driving License / PAN
The System must display the consent/ disclaimer language and collect user's
consent
System must allow upload of front and back page of the Driving licence/ PAN
System Operator / healthcare worker must manually check the documents - Driving
License / PAN
Incorrect OTP
Incorrect OTP
ABHA Details not exists to Aadhaar Number
1. System will check entered mobile is same as Aadhaar linked mobile number. If returns true then user will dire
to ABHA creation screen.
2. For point number 2 step are already mentioned in test case cell no- G20 , point no-2
1. System must verify the mobile number.
1. System must send OTP on mobile number
2. User enters the OTP and clicks on verify
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. Governemnt integrator may use the option for creating default ABHA address. However, it is recommended t
user-defined or system suggested ABHA address be used
2. System should have a provision for private integrators to proceed with the suggested ABHA address.
3. If beneficary use the existing ABHA address then system displays the "ABHA Address is already exist".
1. System shows the 14-digit ABHA number and ABHA address generated
1. System will check entered mobile is same as Aadhaar linked mobile number. If returns true then user will dire
to ABHA creation screen.
2. For point number 2 step are already mentioned in test case cell no- G20 , point no-2
1. System must verify the mobile number.
1. System must send OTP on mobile number
2. User enters the OTP and clicks on verify
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
1. If Integrator is not generating ABHA card then They print the mentioned information on their program/scheme
any other card
a. ABHA Number (Mandatory)
b. ABHA Address
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
Case 2: If beneficary want to create a customize ABHA address then same ABHA address should be displayed
both the ABHA card and the ABHA profile.
3 : Case 3 : If the beneficiary have no ABHA address then system will create a Default ABHA Address ( ABHA Nu
@sbx) and same ABHA address should be displayed on both the ABHA card and the ABHA profile. (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,
name, district name
and ABHA Number.
2.The fields for name, date of birth, and gender are set as non-editable, while the remaining fields can be open
editing.
1. The system displays the 14-digit ABHA number and generates the corresponding ABHA Address, adhering to t
implementation chosen by integrators, either as a default setting or a customized one.
1. System should show the user their ABHA Card
2. ABHA Card should be generated by API and should contain -
a. ABHA Number (Mandatory)
b. ABHA QR code
c. Name, date of birth and gender
d. ABHA Address
1. If Integrator is not generating ABHA card then They print the mentioned information on their program/scheme
any other card with the beneficiary's demographic details.
a. ABHA Number (Mandatory)
b. ABHA Address
1. A healthcare worker/ system operator manually verifies the Driving License / PAN
1. If the user enters a in-valid mobile number(communication) then system will display an error message " Plea
enter a valid mobile number".
1. Incase ABHA Details not exists to communicated Mobile Number in ABHA system.
1. Incase ABHA Details exists to communicated Mobile Number.
1.1. If ABHA Details exists to comunication mobile number exists in ABHA system , In case ' Yes' then syste
will display a message "ABHA Exists to communication Mobile" and user will receive the OTP i.e "OTP sent to AB
linked mobile number ending with ******XXXX" and then Upon verification completion, the system will display a
of ABHA numbers linked to the mobile number, including the following details: Name, ABHA Number, ABHA Addr
and the beneficiary's photograph. When the user attempts to link selected ABHA details, the system will verify i
selected record is present in the HIMS system. If so, it will display a message indicating that the record is alread
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 t
HIMS beneficary's ID or proceed as per bussiness requirement OR benefciary can download the ABHA card (Opti
1. In case of incorrect OTP, the verification fails and display the relevant message.
1. System may activate the Resend OTP button maximum 2 times after 60 seconds in the OTP not received.
1.If the user enters wrong Aadhaar Number then system will display an error message "Invalid LoginId" or som
relevant message i.e "Aadhaar Number is not valid".
1. In case of incorrect OTP, the verification fails and display the relevant message.
1. Beneficary enter Aadhaar Number .
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".
4. The system should have a provision to create ABHA.
1. System may activate the Resend OTP button maximum 2 times after 60 seconds in the OTP not received.
ABHA Number should be validated in the database if already exists before creating a new patient id to avoid tag
of multiple patient id with same ABHA Number.
Kindly Note: This test scenario is applicable for both new and existing beneficiaries and linking will be happens
ABHA creation and verification flow.
1. Log into PHR app.
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 address, Name, Gender, DoB, Mobile No
Address. Below this consent language is displayed - "Your consent to the above information to be shared with <HIP Name>. Th
can use this information for your registration and linking your health records" and both "Cancel" / "Share" buttons are provide
4.Check that after clicking on "Share" button, user profile is successfully shared with the HIP and if user click on "Cancel" butto
then user profile is not shared with the HIP.
5. User clicks on share and gets a token number.
6. User clicks on ok and gets token number with validity of 30 minutes.
Expected Result
User provides consent for sharing of Aadhaar details and creation of ABHA.
System records user consent for compliance with Health Data Management
Policy.
User provides consent for sharing of Aadhaar details and creation of ABHA.
System records user consent for compliance with Health Data Management
Policy.
User will be able to enter a valid Aadhaar OTP (A valid Aadhaar OTP is a 6-
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".
User should be able to view the generated ABHA Number and linked ABHA
address
User should be able to view their ABHA Card with all the demographc details
as mentioned in cell H26
User should be able to view card with ABHA number and ABHA address and
the details should be saved in HIMS system and linked with the HIMS unique
beneficary 's ID.g or as per their business requirement.
User provides consent for sharing of Aadhaar details and creation of ABHA.
System records user consent for compliance with Health Data Management
Policy.
User provides consent for sharing of Aadhaar details and creation of ABHA.
System records user consent for compliance with Health Data Management
Policy.
User should be able to view card with ABHA number and ABHA address and
the details should be saved in HIMS system and linked with the HIMS unique
beneficary 's ID.g or as per their business requirement.
User provides consent for sharing of Aadhaar details and creation of ABHA.
System records user consent for compliance with Health Data Management
Policy.
User provides consent for sharing of Aadhaar details and creation of ABHA.
System records user consent for compliance with Health Data Management
Policy.
User is prompted to enter correct Aadhaar Number
User should be able to view card with ABHA number and ABHA address.and
the details should be saved in HIMS system and linked with the HIMS unique
beneficary 's ID.g or as per their business requirement.
User provides consent for sharing of Aadhaar details and creation of ABHA.
System records user consent for compliance with Health Data Management Policy.
In case the document is invalid, the operator rejects the ABHA creation.
User should be able to view card with ABHA number and ABHA address.
1. In case of correct OTP, the verification is complete and the System can
fetch user's ABHA profile - name, date of birth, gender, mobile number, photo
and address, ABHA Number , ABHA Address and other details from the APIs.
2. In case of incorrect OTP, the verification fails.
3. The fields for name, date of birth, and gender are set as non-editable,
while the remaining fields can be open for editing i.e (Address, Email , Mobile
Number, State, district , City e.t.c)
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. In case of correct OTP, the verification is complete and the System can
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.
3. The fields for name, date of birth, and gender are set as non-editable,
while the remaining fields can be open for editing i.e (Address, Email , Mobile
Number, State, district , City e.t.c)
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. In case of correct OTP, the verification is complete and the System can
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.
2.In case of incorrect OTP, the verification fails.
2. The fields for name, date of birth, and gender are set as non-editable,
while the remaining fields can be open for editing i.e (Address, Email , Mobile
Number, State, district , City e.t.c)
4. After verification , the details should be saved in HIMS system and linked
with the HIMS unique beneficary 's ID.
1. In case of correct OTP, the verification is complete and the System can
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.
3. The fields for name, date of birth, and gender are set as non-editable,
while the remaining fields can be open for editing i.e (Address, Email , Mobile
Number, State, district , City e.t.c)
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.
In case the biometrics match, the verification is complete and the System
can fetch user's ABHA profile - name, date of birth, gender, mobile number,
photo and address, ABHA Number , ABHA Address and other details from the
APIs.
System reads the user information from the ABHA QR code - name, date of
birth, gender, mobile and other details into the system for registration.
The system should not allow login through the same ABHA
https://abhasbx.abdm.gov.in/abha/api/v3/enrollment/request/otp
https://abhasbx.abdm.gov.in/abha/api/v3/enrollment/enrol/byAadhaar
https://abhasbx.abdm.gov.in/abha/api/v3/enrollment/request/otp
https://abhasbx.abdm.gov.in/abha/api/v3/enrollment/auth/byAbdm
https://abhasbx.abdm.gov.in/abha/api/v3/enrollment/enrol/suggestion
https://abhasbx.abdm.gov.in/abha/api/v3/enrollment/enrol/abha-address
https://abhasbx.abdm.gov.in/abha/api/v3/profile/account
https://abhasbx.abdm.gov.in/abha/api/v3/profile/account/abha-card
https://abhasbx.abdm.gov.in/abha/api/v3/enrollment/enrol/byAadhaar
https://abhasbx.abdm.gov.in/abha/api/v3/enrollment/request/otp
https://abhasbx.abdm.gov.in/abha/api/v3/enrollment/auth/byAbdm
https://abhasbx.abdm.gov.in/abha/api/v3/enrollment/enrol/suggestion
https://abhasbx.abdm.gov.in/abha/api/v3/enrollment/enrol/abha-address
https://abhasbx.abdm.gov.in/abha/api/v3/profile/account
https://abhasbx.abdm.gov.in/abha/api/v3/profile/account/abha-card
https://abhasbx.abdm.gov.in/abha/api/v3/enrollment/enrol/byAadhaar
https://abhasbx.abdm.gov.in/abha/api/v3/profile/account
https://abhasbx.abdm.gov.in/abha/api/v3/profile/account/abha-card
https://abhasbx.abdm.gov.in/abha/api/v3/enrollment/request/otp
https://abhasbx.abdm.gov.in/abha/api/v3enrollment/auth/byAbdm
https://abhasbx.abdm.gov.in/abha/api/v3/enrollment/enrol/byDocument
https://abhasbx.abdm.gov.in/abha/api/v3/profile/login/request/otp
https://abhasbx.abdm.gov.in/abha/api/v3/profile/login/verify
https://abhasbx.abdm.gov.in/abha/api/v3/profile/account
https://abhasbx.abdm.gov.in/abha/api/v3/profile/account/abha-card
https://abhasbx.abdm.gov.in/abha/api/v3/phr/web/login/abha/search
https://abhasbx.abdm.gov.in/abha/api/v3/phr/web/login/abha/request/otp
https://abhasbx.abdm.gov.in/abha/api/v3/phr/web/login/abha/verify
https://abhasbx.abdm.gov.in/abha/api/v3/phr/web/login/profile/abha-profile
https://abhasbx.abdm.gov.in/abha/api/v3/phr/web/login/profile/abha/phr-card
https://abhasbx.abdm.gov.in/abha/api/v3/profile/login/request/otp
https://abhasbx.abdm.gov.in/abha/api/v3/profile/login/verify
https://abhasbx.abdm.gov.in/abha/api/v3/profile/account
https://abhasbx.abdm.gov.in/abha/api/v3/profile/account/abha-card
https://abhasbx.abdm.gov.in/abha/api/v3/phr/web/login/abha/search
https://abhasbx.abdm.gov.in/abha/api/v3/phr/web/login/abha/request/otp
https://abhasbx.abdm.gov.in/abha/api/v3/phr/web/login/abha/verify
https://abhasbx.abdm.gov.in/abha/api/v3/phr/web/login/profile/abha-profile
https://abhasbx.abdm.gov.in/abha/api/v3/phr/web/login/profile/abha/phr-card
https://abhasbx.abdm.gov.in/abha/api/v3/profile/login/request/otp
https://abhasbx.abdm.gov.in/abha/api/v3/profile/login/verify
https://abhasbx.abdm.gov.in/abha/api/v3/profile/login/verify/user
https://abhasbx.abdm.gov.in/abha/api/v3/profile/account
https://abhasbx.abdm.gov.in/abha/api/v3/profile/account/abha-card
https://abhasbx.abdm.gov.in/abha/api/v3/profile/login/request/otp
https://abhasbx.abdm.gov.in/abha/api/v3/profile/login/verify
https://abhasbx.abdm.gov.in/abha/api/v3/profile/account
https://abhasbx.abdm.gov.in/abha/api/v3/profile/account/abha-card
https://abhasbx.abdm.gov.in/abha/api/v3/profile/login/verify
https://abhasbx.abdm.gov.in/abha/api/v3/profile/account
https://abhasbx.abdm.gov.in/abha/api/v3/profile/account/abha-card
No API
No APIs
https://abhasbx.abdm.gov.in/abha/api/v3/profile/account/request/otp
https://abhasbx.abdm.gov.in/abha/api/v3/profile/account/verify
https://abhasbx.abdm.gov.in/abha/api/v3/profile/account
https://abhasbx.abdm.gov.in/abha/api/v3/profile/account/request/otp
https://abhasbx.abdm.gov.in/abha/api/v3/profile/account/verify
https://abhasbx.abdm.gov.in/abha/api/v3/profile/account/request/otp
https://abhasbx.abdm.gov.in/abha/api/v3/profile/account/verify
https://abhasbx.abdm.gov.in/abha/api/v3/profile/account/request/otp
https://abhasbx.abdm.gov.in/abha/api/v3/profile/account/verify
https://abhasbx.abdm.gov.in/abha/api/v3/profile/login/request/otp
https://abhasbx.abdm.gov.in/abha/api/v3/profile/login/verify/user
NO APIs
https://dev.abdm.gov.in/api/hiecm/patient-share/v3/on-share