Fetch ABHA by Aadhaar number

Find insurance cover recorded against an ABHA number

Documented responses include 400, 401 and 500 as well as 200. Handle all four.

GET/v3/profile/benefit/abha/search/insurance/{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 insurance programmes linked to the ABHA.

400

The error returned, with its code and message.

Error codes for this module

401

The error returned, with its code and message.

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

The error returned, with its code and message.

Error codes for this module

Find insurance cover recorded against an ABHA number

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

{
  "abhaNumber": "<ABHA_NUMBER>",
  "entityType": "Insurance",
  "insuranceProgramsLinked": [
    "Health ID Test"
  ]
}

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