ABHA creation, Aadhaar OTP

Claim a chosen ABHA address

Attaches the address the person picked to the ABHA number created earlier. preferred: 1 marks it as the one to show.

MandatoryEither of the test cases CRT_ABHA_114 or CRT_ABHA_115 is mandatory for Governement Optional for Private. Either of the test cases CRT_ABHA_209 or CRT_ABHA_210 is mandatory for Governement Optional for Private. Mandatory for Private. Mandatory for Private /Government (Optional for integrated program using demo auth as they have default ABHA address generated)

Certification cases CRT_ABHA_101, CRT_ABHA_102, CRT_ABHA_103, CRT_ABHA_104, CRT_ABHA_105, CRT_ABHA_106, CRT_ABHA_107, CRT_ABHA_108, CRT_ABHA_109, CRT_ABHA_112, CRT_ABHA_113, CRT_ABHA_114, CRT_ABHA_115, CRT_ABHA_201, CRT_ABHA_202, CRT_ABHA_203, CRT_ABHA_204, CRT_ABHA_205, CRT_ABHA_206, CRT_ABHA_207, CRT_ABHA_208, CRT_ABHA_209, CRT_ABHA_210

POST/v3/enrollment/enrol/abha-address

Until this succeeds the account has only the default address that the service issues automatically, which is the fourteen digit number followed by @sbx or @abdm and which nobody can remember.

The ABHA number comes back from this call as healthIdNumber, not as ABHANumber. The enrol response spells the same value ABHANumber, so a client that reuses its enrol parsing here reads nothing.

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

txnIdstringRequired

abhaAddressstringRequired

preferredintegerRequired

Responses

200

Response body not fully documented. healthIdNumber is confirmed; the rest of the shape is not.

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

Claim a chosen ABHA address

curl --request POST \
  --url https://abhasbx.abdm.gov.in/abha/api/v3/enrollment/enrol/abha-address \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'REQUEST-ID: <REQUEST_ID>' \
  --header 'TIMESTAMP: <TIMESTAMP>' \
  --header 'Content-Type: application/json' \
  --data '{
  "txnId": "<TXN_ID>",
  "abhaAddress": "<ABHA_ADDRESS>",
  "preferred": 1
}'

{
  "healthIdNumber": "<HEALTH_ID_NUMBER>"
}

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