Benefit search by ABHA number

Lists the benefit programmes linked to an ABHA number. loginId is the RSA-encrypted ABHA number.

POST/abha/api/v3/profile/benefit/search

Endpoint: POST /abha/api/v3/profile/benefit/search

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

Headers (plus Authorization: Bearer <gateway token>):

Header	Required	Description
REQUEST-ID	yes	Unique UUID for every request.
TIMESTAMP	yes	Current UTC timestamp in ISO-8601 format.
BENEFIT_NAME	yes	Benefit / programme name approved by NHA for the integrator.

Request body for this use case:

Field	Value / Type	Required	Description
`scope`	`["search"]`	yes	Scope that selects this use case. Send exactly the values listed for this API.
`loginHint`	`"ABHA-number"`	yes	Type of identifier sent in `loginId`.
`loginId`	string	yes	Identifier value, RSA-encrypted with the ABHA public certificate.

Responses

200

Success: Benefit Search via ABHA number; Benefit found (Postman); Benefit found - sandbox (Postman)

400

Bad Request (request validation failed): Invalid Scope; Invalid Login Hint; Invalid LoginId; Invalid Benefit Name

Error codes for this module

loginIdstring

timestampstring

401

Unauthorized (invalid / expired gateway token, X-token or benefit access): Invalid access token

Everything returns 401

codestring

messagestring

descriptionstring

404

Not Found: User Not Found

Error codes for this module

errorobject

error.codestring

error.messagestring

500

Internal Server Error.

Error codes for this module

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: 18235d89-cb13-479d-ad71-7a57d5f669a8' \
  --header 'TIMESTAMP: 2022-10-06T15:10:00.587Z' \
  --header 'BENEFIT_NAME: {{Benefit Name}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "scope": [
    "search"
  ],
  "loginHint": "abha-number",
  "loginId": "{{encrypted abha-number}}"
}'

[
  {
    "benefitName": "healthid api",
    "abhaNumber": "<ABHA_NUMBER>",
    "status": 1
  }
]