Enrollment · ABDM V3 Sandbox

Enroll by ABDM

Alternate ABDM enrollment operation using an OTP-authenticated transaction and enrollment consent.

POST · Sandbox

API requirements

Completes ABHA enrollment through the ABDM enrollment route rather than the Aadhaar-specific route.

First request an enrollment OTP using the appropriate sandbox enrollment scope.
Supply the valid transaction ID and OTP that belong to the same enrollment attempt.
Use only identities and OTPs explicitly provided for sandbox testing.

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 for the enrollment transaction.
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.

Review the response for ABHA number and profile details. The response can differ based on the sandbox identity.

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