Skip to main content

Benefit search by xmlUid

Lists the benefit programmes linked to an Aadhaar xmlUid. loginId is the RSA-encrypted xmlUid.

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 "xmlUid" 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 xmlUid; Benefit found (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