Milestone 1: ABHA creation and capture &

SlNo Purpose Serial API

1 Registration 1.0.1 v1/auth/cert

1.1 Registration Via Aadhaar 1.1.1 v1/registration/aadhaar/generateOtp

1.1.2 v1/registration/aadhaar/verifyOTP
1.1.3 v1/registration/aadhaar/generateMobileOTP
1.1.4 v1/registration/aadhaar/verifyMobileOTP
1.1.5 v1/registration/aadhaar/createHealthIdByAadhar
1.1.6 v1/search/existsByHealthId

1.2 Registration via Mobile 1.2.1 v2/registration/mobile/generateOtp

1.2.2 v2/registration/mobile/verifyOtp
1.2.3 v2/registration/mobile/createHidViaMobile
1.2.4 v2/registration/mobile/resendOtp

1.3 Registration via Driving Licence 1.3.1 v2/document/generate/mobile/otp

1.3.2 v2/document/verify/mobile/otp
1.3.3 v2/document/validate
1.3.4 v2/document

2 Login 2.0.1 v1/auth/cert

2.0.2 v1/search/searchByHealthId
2.0.3 v1/auth/init

2.1 Login via Aadhaar OTP 2.1.1 v1/auth/confirmWithAadhaarOtp

2.2 Login via Mobilr OTP 2.2.1 v1/auth/confirmWithMobileOTP

2.3 Login via Password 2.3.1 v1/auth/authPassword

3 Forgot ABHA 3.0.1 v1/auth/cert

3.0.2 v1/search/searchByHealthId

3.1 Retrieve ABHA via Aadhaar 3.1.1 v2/auth/reactivate/init

3.1.2 v2/auth/reactivate

3.2 Retrieve Health ID via Mobile 3.2.1 v2/auth/reactivate/init

3.2.2 v2/auth/reactivate

3.3 Retrieve Health ID via Password 3.3.1 v2/auth/reactivate/init

4 Profile
4.1 Get Profile 4.1.1 v1/account/profile

5 Get QR code 5.1.1 v1/account/qrCode

6 Edit Profile

6.1 Update Password

6.1.1 Update Password Via Aadhaar Otp 6.1.1.1 v1/account/change/passwd/generateAadhaarOTP
6.1.1.2 v1/account/change/passwd/byAadhaar
6.1.1.3 v1/account/logout

6.1.2 Update Password Via Password 6.1.2.1 v1/account/change/password

6.1.2.2 v1/account/logout

6.1.3 Update Password Via Mobile Otp 6.1.3.1 v1/account/change/passwd/generateMobileOTP

6.1.3.2 v1/account/change/passwd/byMobile
6.1.3.3 v1/account/logout

6.2 Update Mobile

6.2.1 Update Mobile via Password 6.2.1.1 v2/account/change/mobile/new/generateOTP
6.2.1.2 v2/account/change/mobile/new/verifyOTP
6.2.1.3 v2/account/change/mobile/update/authentication

6.2.2 Update Mobile via Aadhaar Otp 6.2.2.1 v2/account/change/mobile/new/generateOTP

6.2.2.2 v2/account/change/mobile/new/verifyOTP
6.2.2.3 v2/account/change/mobile/aadhaar/generateOTP
6.2.2.4 v2/account/change/mobile/update/authentication

6.2.3 Update Mobile via Mobile Otp 6.2.3.1 v2/account/change/mobile/new/generateOTP

6.2.3.2 v2/account/change/mobile/new/verifyOTP
6.2.3.3 v2/account/change/mobile/old/generateOTP
6.2.3.4 v2/account/change/mobile/update/authentication

6.3 Update Email

6.3.1 Update Email Via Aadhaar Otp 6.3.1.1 v2/account/email/verification/auth/initiate/send
6.3.1.2 v2/account/email/verification/auth/verify

6.3.2 Update Email Via Mobile Otp 6.3.2.1 v2/account/email/verification/auth/initiate/send

6.3.2.2 v2/account/email/verification/auth/verify

6.3.3 Update Email Via Password 6.3.3.1 v2/account/email/verification/auth/initiate/send

6.3.3.2 v2/account/email/verification/auth/verify

OPT OUT FEATURE

7 Delete ABHA
7.1 Delete ABHA using Aadhaar 7.1.1 v2/account/aadhaar/generateOTP
7.1.2 v2/account/profile/delete

7.2 Delete ABHA using Mobile 7.2.1 v2/account/mobile/generateOTP

7.2.2 v2/account/profile/delete

7.3 Delete ABHA using password 7.3.1 v2/account/profile/delete

8 Deactivate ABHA
8.1 Deactivate ABHA using Aadhaar 8.1.1 v2/account/aadhaar/generateOTP
8.1.2 v2/account/profile/deactivate

8.2 Deactivate ABHA using Mobile 8.2.1 v2/account/mobile/generateOTP

8.2.2 v2/account/profile/deactivate

8.3 Deactivate ABHA using password 8.3 v2/account/profile/deactivate

ne 1: ABHA creation and capture & verification for seamless patient registration

Description

Authentication token public certificate. This certificate is also used to encrypt the data.

Generate Aadhaar OTP on Registered mobile number

Verify Aadhaar OTP received on Registered mobile number
Generate Mobile OTP for verification.
Verify Mobile OTP in an existing transaction.
Create Health ID using pre-verified Aadhaar & Mobile.
Check the ABHA in our system.This API checks ifABHA is reserved/used which includes permanently deleted ABHAs.

Generate Mobile OTP to start registration transaction

Verify Mobile OTP sent as part of registration transaction.
Create ABHA with verified mobile token
Resend Mobile OTP in an existing transaction in case previous OTP is not received.

Generate Mobile OTP

Verify Mobile OTP
Match the provided demographic details against document and check for the already created ABHA or Enrollment number agai
Create ABHA using ID documents like Driving Licence

Authentication token public certificate. This certificate is also used to encrypt the data.
Check the ABHA in our system.This API checks if ABHA is reserved/used which includes permanently deleted ABHAs.
Initiate authentication process for given ABHA

Authentication with Aadhaar OTP based auth transaction

Authentication with Mobile OTP based auth transaction.

Authenticate using ABHA and password

Authentication token public certificate. This certificate is also used to encrypt the data.
Check the ABHA in our system.This API checks if ABHA is reserved/used which includes permanently deleted ABHAs.

Initiate authentication for reactivation of ABHA

Confirm reactivation transaction with aadhar or mobile otp

Initiate authentication for reactivation of ABHA

Confirm reactivation txn with aadhar or mobile otp

Initiate authentication for reactivation of ABHA

Get account information

Get Quick Response code in PNG format for this account.

Generate Aadhaar OTP on Registered mobile number.

Change password via Aadhar for ABHA
Logout

Change password via password for ABHA

Logout

Generate Mobile OTP to start password change process.

Change password via mobile for ABHA
Logout

Generate OTP on new mobile need to update existing account mobile number
Verify Mobile OTP to complete new mobile update verification.
Change mobile number via password/aadhaar/existing mobile for ABHA

Generate OTP on new mobile need to update existing account mobile number
Verify Mobile OTP to complete new mobile update verification.
Generate Aadhaar OTP on Registered mobile number to start mobile update
Change mobile number via password/aadhaar/existing mobile for ABHA

Generate OTP on new mobile need to update existing account mobile number
Verify Mobile OTP to complete new mobile update verification.
Generate Mobile OTP to start mobile update.
Change mobile number via password/aadhaar/existing mobile for ABHA

Send the Email Verification Activation Link to verify the E-mail Address
Verfiy the user initiate the Activation Link

Send the Email Verification Activation Link to verify the E-mail Address
Verfiy the user initiate the Activation Link

Send the Email Verification Activation Link to verify the E-mail Address
Verfiy the user initiate the Activation Link
Generate Aadhaar OTP on Registered for link account with aadhar number
Delete account

Generate Mobile OTP to start mobile txn.

Delete account

Delete account

Generate Aadhaar OTP on Registered for link account with aadhar number
Deactivate the account using mobile or aadhaar otp.

Generate Mobile OTP to start mobile txn.

Deactivate the account using mobile or aadhaar otp.

Deactivate the account using mobile or aadhaar otp.