Enrollment · ABDM V3 Sandbox

Enroll by Aadhaar

Complete ABHA number creation by verifying the OTP issued during Aadhaar enrollment.

POST · Sandbox

API requirements

Submits Aadhaar OTP proof and enrollment consent to create an ABHA account.

Complete Request enrollment OTP first and use its transaction ID.
Enter the OTP delivered to the Aadhaar-linked mobile; never put a real OTP in source control or logs.
The consent code and version must be supplied as returned by the current ABDM sandbox specification.

Field	Type	Required	Requirement
authData.authMethods	array<string>	Yes	Use ["otp"].
authData.otp.txnId	string	Yes	Transaction ID from the enrollment OTP response.
authData.otp.otpValue	string	Yes	OTP received on the Aadhaar-linked mobile.
consent.code	string	Yes	Enrollment consent identifier; sample value: abha-enrollment.
consent.version	string	Yes	Consent version; sample value: 1.4.

Content-Type: application/json and Accept: application/json are sent automatically.
Authorization: Bearer accessToken is added automatically; a session token is requested if none is saved.
A unique REQUEST-ID and UTC TIMESTAMP are generated for each call.
T-TOKEN is taken from the body transaction ID or the saved transaction variable.

A successful response contains the newly created ABHA details. Keep any returned identifiers confidential.

POST https://abhasbx.abdm.gov.in/abha/api/v3/enrollment/enrol/byAadhaar