Skip to main content

Get benefits linked to an ABHA number

Endpoint: GET /abha/api/v3/profile/benefit/abha/{abhanumber}

GET/abha/api/v3/profile/benefit/abha/{abhanumber}

Flow: Benefit - Search - independent API; call the one that fits your identifier / modality.

---

This API endpoint is used to retrieve the benefit details associated with a specific ABHA (Ayushman Bharat Health Account) number. By providing the ABHA number in the request, the API returns information about the benefits linked to that account. This includes details such as the type of benefits, eligibility, and any other relevant information associated with the ABHA number. This endpoint ensures that users can access and manage their health benefits securely and efficiently.

Authorizations

Authorizationbearer tokenRequired

The access token from POST /api/hiecm/gateway/v3/sessions, sent with a Bearer prefix.

Path parameters

abhanumberstringRequired

Headers

BENEFIT_NAMEstringRequired

Benefit / program name approved by NHA for the integrator.

REQUEST-IDstringRequired

Unique UUID for every request.

TIMESTAMPstringRequired

Current UTC timestamp in ISO-8601 format.

Responses

200

This scenario occurs when an ABHA (Ayushman Bharat Health Account) is linked to one or multiple benefit programs. Each benefit program may offer different types of health services, financial assistance, or other healthcare-related benefits. The system ensures that the ABHA number is correctly associated with all the relevant benefit programs, allowing the user to access and manage their benefits efficiently

abhaNumberstring
programmeobject[]
programme.benefitNamestring
401

The 401 response code indicates an unauthorized request. In this context, it refers to the lack of proper authentication

Everything returns 401

codestring
messagestring
descriptionstring
404

The 404 response code indicates that the requested resource could not be found. In the context of searching for an ABHA (Ayushman Bharat Health Account) number using the endpoint API, this error occurs when the specified ABHA number does not exist or cannot be found in the system.

Error codes for this module

errorobject
error.codestring
error.messagestring
500

Internal Server Error

An Internal Server Error (500) indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

Error codes for this module