Skip to main content

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

Optional. Sends an ABDM OTP to an email address so it can be linked to the newly created ABHA. Send the txnId from the previous enrolment step.

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

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

Flow: Create ABHA - IRIS - step 4 of 7

  • Previous: After ABHA creation - verify mobile OTP (optional)
  • Next: After ABHA creation - verify email 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", "email-verify"] yes Scope that selects this use case. Send exactly the values listed for this API.
loginHint "email" 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: Email Verify via OTP-positive flow

txnIdstring
messagestring
400

Bad Request (request validation failed): ABHA Verify via Email-Invalid scope; ABHA Verify via Email-Invalid LoginId; ABHA Verify via Email-Invalid Login Hint

Error codes for this module

scopestring
timestampstring
401

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

Everything returns 401

codestring
messagestring
descriptionstring
500

Internal Server Error.

Error codes for this module

codestring
messagestring
descriptionstring