Fetch ABHA by Aadhaar number

Search benefit records for a person

Searches by encrypted XML UID or by ABHA number, depending on loginHint. Returns an array, one entry per benefit scheme, each with the scheme name, its identifier and a status.

POST/v3/profile/benefit/search

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.

BENEFIT_NAMEstring

The benefit scheme an enrolment belongs to. Send healthid api on the enrol and search calls, and healthid on the login OTP and verify calls under Find ABHA. On the enrolment OTP request the header is present but explicitly disabled, so it is not sent there.

A login OTP request sent with healthid api rather than healthid was accepted on the sandbox on 2026-09-11, so the login calls may take either.

NHA's files spell this header four different ways and use scheme values beyond healthid. Which spelling each endpoint accepts is not confirmed against the sandbox. The Conventions page for this module lists all four.

Body

scopestring[]Required

loginHintstringRequired

loginIdstringRequired

Responses

200

The response.

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

404

Resource not found

Error codes for this module

500

Server error, retry

Error codes for this module

Search benefit records for a person

curl --request POST \
  --url https://abhasbx.abdm.gov.in/abha/api/v3/profile/benefit/search \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'REQUEST-ID: <REQUEST_ID>' \
  --header 'TIMESTAMP: <TIMESTAMP>' \
  --header 'BENEFIT_NAME: healthid api' \
  --header 'Content-Type: application/json' \
  --data '{
  "scope": [
    "search"
  ],
  "loginHint": "xmlUid",
  "loginId": "<ENCRYPTED_XML_UID>"
}'

[
  {
    "stateCode": null,
    "benefitName": "COVIN",
    "benefitId": "<BENEFIT_ID>",
    "abhaNumber": "<ABHA_NUMBER>",
    "status": 0
  }
]

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