ABHA verification, Aadhaar OTP

Send a login OTP, v3.1

The v3.1 variant of the login OTP request. It sits on a different base path from the rest of M1, /abha/api/v3.1 rather than /abha/api/v3, which is why the version appears in the path here.

Mandatory

Certification cases PROF_ABHA_605, 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

POST/v3.1/profile/login/request/otp

Use v3 by default. v3.1 is used for Aadhaar OTP and biometric login.

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

loginHintstringRequired

loginIdstringRequired

otpSystemstringRequired

Responses

200

The specification does not describe this body. Send the call with Try it to see what comes back.

Send a login OTP, v3.1

curl --request POST \
  --url https://abhasbx.abdm.gov.in/abha/api/v3.1/profile/login/request/otp \
  --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"
  ],
  "loginHint": "aadhaar",
  "loginId": "<ENCRYPTED_AADHAAR_NUMBER>",
  "otpSystem": "aadhaar"
}'

The specification does not describe this body. Send the call with Try it to see what comes back.