ABHA creation, Aadhaar OTP

Get suggested ABHA addresses for a new account

Returns a handful of available ABHA addresses built from the person's name and date of birth. Offer them as a choice. The person may type their own instead, subject to the address policy: at least four characters, letters, numbers and dots only, and it may not begin with a number or begin or end with a dot.

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

GET/v3/enrollment/enrol/suggestion

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.

TRANSACTION_IDstring

The enrolment transaction this call belongs to, when the transaction is not carried in the body.

Responses

200

ABHA address suggestions for the transaction.

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

Get suggested ABHA addresses for a new account

curl --request GET \
  --url https://abhasbx.abdm.gov.in/abha/api/v3/enrollment/enrol/suggestion \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'REQUEST-ID: <REQUEST_ID>' \
  --header 'TIMESTAMP: <TIMESTAMP>' \
  --header 'TRANSACTION_ID: <TRANSACTION_ID>'

{
  "txnId": "<TXN_ID>",
  "abhaAddressList": [
    "<ABHA_ADDRESS_LIST>"
  ]
}

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