Skip to main content

Send Aadhaar OTP for ABHA enrolment

Starts ABHA creation with Aadhaar OTP. UIDAI sends an OTP to the mobile number linked with the Aadhaar number.

POST/abha/api/v3/enrollment/request/otp

Use the txnId from the response in Create ABHA - verify Aadhaar OTP.

Endpoint: POST /abha/api/v3/enrollment/request/otp

Flow: Create ABHA - Aadhaar OTP - step 1 of 8

  • Previous: none (first call of this flow)
  • Next: Create ABHA - verify Aadhaar OTP

Headers (plus Authorization: Bearer <gateway token>):

Header Required Description
REQUEST-ID yes Unique UUID for every request.
TIMESTAMP yes Current UTC timestamp in ISO-8601 format.

Request body for this use case:

Field Value / Type Required Description
txnId string no Transaction ID returned by the previous step of this flow.
scope ["ABHA-enrol"] yes Scope that selects this use case. Send exactly the values listed for this API.
loginHint "Aadhaar" yes Type of identifier sent in loginId.
loginId string yes Identifier value, RSA-encrypted with the ABHA public certificate.
otpSystem "Aadhaar" yes System that generates and delivers the OTP (Aadhaar = UIDAI, ABDM = ABDM).

Note: txnId is optional here. Leave it empty on the first call, or send a previous txnId to resend the OTP.

Responses

200

Success: ABHA enrolment via Aadhaar-positive flow; ABHA Creation via Aadhaar OTP-REQUEST OTP FOR AADHAAR AUTHENTICATION

txnIdstring
messagestring
400

Bad Request (request validation failed): ABHA enrolment via Aadhaar-Invalid scope; ABHA enrolment via Aadhaar-Invalid LoginId; ABHA enrolment via Aadhaar-Invalid Login Hint; ABHA Creation via Aadhaar OTP-Invalid scope; ABHA Creation via Aadhaar OTP-Invalid Login Hint

Error codes for this module

scopestring
timestampstring
401

Unauthorized (invalid / expired gateway token, X-token or benefit access): ABHA enrolment via Aadhaar-Invalid access token; ABHA Creation via Aadhaar OTP-Invalid access token

Everything returns 401

codestring
messagestring
descriptionstring
500

Internal Server Error.

Error codes for this module

codestring
messagestring
descriptionstring