Module 2

ABHA Enrollment Actions

This page is now split by Milestone 1 actions so we can implement each ABDM enrollment step separately and keep the flow easier to test.

Auto refresh token on expiry
Step 2.1

Enroll ABHA Using Aadhaar OTP

Use Aadhaar OTP, then submit the OTP along with the mobile number for ABHA communication. This step can return either a new ABHA or an existing ABHA profile.

Step 2.1.1

ABHA Address

Test the address flow in order: suggest an address, create the selected address, then verify it from the profile account response.

Step 2.2

Update Mobile Number

This is a separate action after enrollment. It uses the enrollment transaction and ABHA context from step 2.1 to send and verify a mobile OTP through ABDM.

Step 2.3

Email Verification

Send a separate encrypted email verification link for the ABHA profile.

Step 2.4

ABHA Profile APIs

Execute profile account APIs using the ABHA token returned by the enrollment flow.

Transaction Details

  • Transaction ID: Not generated
  • Enrollment Txn ID: Not available
  • ABHA Token: Not available
  • Mobile Verify Txn ID: Not available
  • OTP Message: Not available
  • Mobile OTP Message: Not available
  • Email: Not available
  • Email Verification Message: Not available
  • Address Suggestion Message: Not available
  • Address Verification Message: Not available
  • Aadhaar: Not available
  • Mobile: Not available

ABHA Result

  • Status: Not available
  • ABHA Status: Not available
  • ABHA Number: Not created
  • ABHA Address: Not created
  • Name: Not available
  • Gender: Not available
  • DOB: Not available
  • Mobile: Not available
  • Is New: Not available

API Request JSON

API Response JSON