Get the benefit record for an ABHA number

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

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

Unique UUID v4 per request. Used for idempotency and distributed tracing. Generate a fresh UUID for every call.

ISO 8601 UTC timestamp of the request.

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.

The benefit programmes recorded against the ABHA.

Bad Request, invalid scope, loginHint, or encrypted field

Error codes for this module

Unauthorized, missing, invalid, or expired Bearer token

Everything returns 401

Forbidden, the token is valid but not permitted for this operation

Error codes for this module

Server error, retry

Error codes for this module