ABHA verification, Aadhaar OTP

Verify a login OTP, v3.1

The v3.1 counterpart of the login verification, on the /abha/api/v3.1 base path.

Mandatory

Certification cases VRFY_ABHA_101, VRFY_ABHA_201, VRFY_ABHA_301, VRFY_ABHA_302, VRFY_ABHA_303, VRFY_ABHA_304, VRFY_ABHA_305, VRFY_ABHA_401, VRFY_ABHA_402, VRFY_ABHA_403, VRFY_ABHA_404, VRFY_ABHA_405, VRFY_ABHA_501

POST/v3.1/profile/login/verify

Authorizations

Authorizationbearer tokenRequired

The accessToken from POST /api/hiecm/gateway/v3/sessions. Send it as Authorization: Bearer <ACCESS_TOKEN>.

Headers

REQUEST-IDstringRequired

Unique UUID v4 per request. Used for idempotency and distributed tracing. Generate a fresh UUID for every call.

TIMESTAMPstringRequired

ISO 8601 UTC timestamp of the request.

Body

scopestring[]Required

authDataobjectRequired

authData.authMethodsstring[]Required

authData.otpobject

authData.otp.txnIdstringRequired

authData.otp.otpValuestringRequired

authData.face_loginobject

authData.face_login.aadhaarstringRequired

authData.face_login.faceAuthPidstring

authData.face_login.txnIdstring

authData.bio_loginobject

authData.bio_login.aadhaarstringRequired

authData.bio_login.fingerPrintAuthPidstringRequired

authData.iris_loginobject

authData.iris_login.aadhaarstringRequired

authData.iris_login.irisAuthPidstringRequired

Responses

200

Whether the login verified, with the user token and its expiry.

Verify a login OTP, v3.1

curl --request POST \
  --url https://abhasbx.abdm.gov.in/abha/api/v3.1/profile/login/verify \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'REQUEST-ID: <REQUEST_ID>' \
  --header 'TIMESTAMP: <TIMESTAMP>' \
  --header 'Content-Type: application/json' \
  --data '{
  "scope": [
    "abha-login",
    "aadhaar-verify",
    "aadhaar-otp-verify"
  ],
  "authData": {
    "authMethods": [
      "otp"
    ],
    "otp": {
      "txnId": "<TXN_ID>",
      "otpValue": "<OTPVALUE>"
    }
  }
}'

{
  "txnId": "<TXN_ID>",
  "authResult": "success",
  "message": "FACE verified successfully",
  "token": "<TOKEN>",
  "expiresIn": 1800,
  "refreshToken": "<REFRESHTOKEN>",
  "refreshExpiresIn": 1296000,
  "accounts": [
    {
      "ABHANumber": "<ABHA_NUMBER>",
      "preferredAbhaAddress": "<ABHA_ADDRESS>",
      "name": "<NAME>",
      "status": "ACTIVE",
      "profilePhoto": "<BASE64_PHOTO>"
    }
  ]
}

Generated from the schema. The values are placeholders, not a captured response.