Skip to main content

After ABHA creation - send OTP to verify mobile (optional)

Optional, called after the ABHA is created. Needed only when the mobile sent in the create-ABHA call is not the Aadhaar-linked mobile.

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

ABDM sends an OTP to that mobile number so it can be linked to the ABHA. Send the txnId from the ABHA creation response.

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

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

  • Previous: Create ABHA - verify Aadhaar OTP
  • Next: After ABHA creation - verify mobile OTP (optional)

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 yes Transaction ID returned by the previous step of this flow.
scope ["ABHA-enrol", "mobile-verify"] yes Scope that selects this use case. Send exactly the values listed for this API.
loginHint "mobile" yes Type of identifier sent in loginId.
loginId string yes Identifier value, RSA-encrypted with the ABHA public certificate.
otpSystem "ABDM" yes System that generates and delivers the OTP (Aadhaar = UIDAI, ABDM = ABDM).

Responses

200

Success: Mobile Update - Send OTP- positive flow

txnIdstring
messagestring
400

Bad Request (request validation failed): Mobile Update - Send OTP-Invalid Scope; Mobile Update - Send OTP-Invalid LoginId; Mobile Update - Send OTP-Invalid Login Hint

Error codes for this module

scopestring
timestampstring
401

Unauthorized (invalid / expired gateway token, X-token or benefit access): Mobile Update - Send OTP-Invalid access token

Everything returns 401

codestring
messagestring
descriptionstring
500

Internal Server Error.

Error codes for this module

codestring
messagestring
descriptionstring