Skip to main content

After ABHA creation - verify mobile OTP (optional)

Verifies the OTP sent by *After ABHA creation - send OTP to verify mobile (optional)* and links the mobile number to the newly created ABHA.

POST/abha/api/v3/enrollment/auth/byAbdm

Endpoint: POST /abha/api/v3/enrollment/auth/byAbdm

Flow: Create ABHA - Face Authentication - step 5 of 9

  • Previous: After ABHA creation - send OTP to verify mobile (optional)
  • Next: After ABHA creation - send OTP to verify email (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
scope ["ABHA-enrol", "mobile-verify"] yes Scope that selects this use case. Send exactly the values listed for this API.
authData object yes Authentication payload for this use case.
authData.authMethods ["OTP"] yes Authentication method used in this step.
authData.otp object yes OTP authentication block.
authData.otp.txnId string yes Transaction ID returned by the previous step of this flow.
authData.otp.otpValue string yes OTP received by the user, RSA-encrypted.

Responses

200

Success: Mobile Update - Verify OTP-positive flow; Mobile Update - Verify OTP-OTP EXPIRED

txnIdstring
authResultstring
messagestring
accountsobject[]
400

Bad Request (request validation failed): Mobile Update - Verify OTP; Invalid Transaction Id; Invalid Scope; Invalid AuthMethod

Error codes for this module

txnIdstring
timestampstring
401

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

Everything returns 401

codestring
messagestring
descriptionstring
500

Internal Server Error: Mobile Update - Verify OTP-Invalid access token

Error codes for this module

codestring
messagestring
descriptionstring