ABHA creation, Aadhaar biometric

Start face or biometric authentication and get a transaction id

Returns the txnId that a QR code is built from. The person scans that QR with the ABHA app, completes face authentication through the Aadhaar RD service, and you then continue with the captured result.

POST/v3/enrollment/enrol/auth/init

The same call starts the face authentication login flow, not only enrolment.

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

The recorded request sends ["abha-enrol", "face-auth"]. The collection's own comments name the variant: face-auth starts the flow without a PID block, face-verify is the route with one. Confirm against sandbox before relying on either.

Responses

200

The transaction id to carry into the next step, with a message.

400

Bad Request, invalid scope, loginHint, or encrypted field

Error codes for this module

401

Unauthorized, missing, invalid, or expired Bearer token

Everything returns 401

403

Forbidden, the token is valid but not permitted for this operation

Error codes for this module

500

Server error, retry

Error codes for this module

Start face or biometric authentication and get a transaction id

curl --request POST \
  --url https://abhasbx.abdm.gov.in/abha/api/v3/enrollment/enrol/auth/init \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'REQUEST-ID: <REQUEST_ID>' \
  --header 'TIMESTAMP: <TIMESTAMP>' \
  --header 'Content-Type: application/json' \
  --data '{
  "scope": [
    "abha-enrol",
    "face-auth"
  ]
}'

{
  "txnId": "<TXN_ID>",
  "message": "<MESSAGE>"
}

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