Skip to main content

Link / De-link benefit using X-token

Links (scope: ["link"]) or de-links (scope: ["de-link"]) the benefit named in the BENEFIT_NAME header for the ABHA of the logged-in user (X-token).

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

The body has only scope.

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.
X-token yes User token (Bearer <token>) received after verification / login.

Request body for this use case:

Field Value / Type Required Description
scope ["link"] yes Scope that selects this use case. Send exactly the values listed for this API.

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 x-token

Error codes for this module

codestring
messagestring
401

Unauthorized (invalid / expired gateway token, X-token or benefit access): Invalid access token; Invalid benefit name; De-link_insurance restricted; link- Insurance restricted

Everything returns 401

codestring
descriptionstring
messagestring
500

Internal Server Error.

Error codes for this module