Skip to main content

Link / De-link benefit using xmlUid

Links (scope: ["link"]) or de-links (scope: ["de-link"]) the benefit named in the BENEFIT_NAME header for an Aadhaar xmlUid. loginId is the RSA-encrypted xmlUid.

POST/abha/api/v3/profile/benefit/linkAndDelink

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

Flow: Benefit - Link / De-link - 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 ["de-link"] 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: Linked successfully; Linked successfully (2); Linked successfully (Postman); De-linked successfully

benefitNamestring
healthIdstring
statusstring
400

Bad Request (request validation failed): Already de-linked (spec); Already linked; Already de-linked; Invalid Login ID

Error codes for this module

codestring
messagestring
401

Unauthorized (invalid / expired gateway token, X-token or benefit access): Invalid access token; Insurance Restricted - De-link; Insurance Restricted - Link; Invalid Benefit Name - Link; Invalid Benefit Name - De-link

Everything returns 401

codestring
descriptionstring
messagestring
500

Internal Server Error.

Error codes for this module