Enrollment · ABDM V3 Sandbox
Request enrollment OTP
Start a new ABHA enrollment flow by asking ABDM to send a one-time password to the Aadhaar-linked mobile.
API requirements
Creates the enrollment transaction that is required for a subsequent Aadhaar OTP verification request.
- Use an ABDM sandbox test identity and ensure its Aadhaar-linked mobile is available to receive the test OTP.
- The phone number used by Aadhaar authentication must be linked to the submitted Aadhaar number.
- On success, the transaction ID is stored automatically for the enrollment step.
Request fields
| Field | Type | Required | Requirement |
|---|---|---|---|
| scope | array<string> | Yes | For Aadhaar enrollment use ["abha-enrol", "mobile-verify"]. |
| loginHint | string | Yes | Use aadhaar for this flow. |
| loginId | string | Yes | The 12-digit Aadhaar test number accepted by the sandbox. |
| otpSystem | string | Yes | Use aadhaar to route OTP verification. |
Headers & variables
Content-Type: application/jsonandAccept: application/jsonare sent automatically.Authorization: Bearer accessTokenis added automatically; a session token is requested if none is saved.- A unique
REQUEST-IDand UTCTIMESTAMPare generated for each call.
After this request
Copy the received OTP into Enroll by Aadhaar. The transaction ID returned by this response is saved automatically.
Send request
POST https://abhasbx.abdm.gov.in/abha/api/v3/enrollment/request/otp