Fetch ABHA by Aadhaar number

Get the state and district recorded against an ABHA number

Used to route a person to the right scheme, since eligibility is often decided by where they live.

GET/v3/profile/benefit/abha/statedistrict/{abhaNumber}

Authorizations

Authorizationbearer tokenRequired

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

Path parameters

abhaNumberstringRequired

A fourteen digit ABHA number, written in the hyphenated form NHA uses, for example 91-1234-5678-9012.

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.

Responses

200

The state and district codes recorded against the ABHA.

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 the state and district recorded against an ABHA number

curl --request GET \
  --url https://abhasbx.abdm.gov.in/abha/api/v3/profile/benefit/abha/statedistrict/{abhaNumber} \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'REQUEST-ID: <REQUEST_ID>' \
  --header 'TIMESTAMP: <TIMESTAMP>'

{
  "abhaNumber": "<ABHA_NUMBER>",
  "stateCode": 0,
  "districtCode": 0,
  "status": "<STATUS>"
}

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