Skip to main content

Get beneficiary policies (v2)

v2 variant of the beneficiary policy lookup; same FetchParticipantPoliciesRequest body and ParticipantListResponse as the unversioned call.

POST/v2/participant/get/policies

Business purpose

This endpoint answers the same question as /participant/get/policies: which payer products is this beneficiary linked to, and therefore which payer or TPA should the hospital address. The OpenAPI document exposes it as getParticipantGetPoliciesV2 with an identical request and response schema and the same Registry APIs tag; the documentation records no behavioural difference beyond the path. Integrations that use the v2 link and de-link calls typically read back through this endpoint.

When to use

Use it at the same point as the v1 lookup, before eligibility and pre-authorisation. Payers also use it to check a link they just made.

Preconditions

  • You have a valid access token in the bearer_auth header.
  • The payer or TPA has already linked the member.
  • Send the ABHA number without hyphens.

Postconditions

You get the member's linked policies. Cache them, and force a refresh when something changes on the payer side.

Common mistakes

  • Using the payer ID as x-hcx-recipient_code. Use the processing ID from this response.
  • Sending the ABHA number with hyphens.
  • Trying only one identifier type.

Best practices

  • Normalise the ABHA number (strip separators) before the call and try identifiers in the documented priority order: ABHA, then MemberId from the latest admission, then mobile number.
  • Cache successful lookups keyed by patient, but expose a forceRefresh path and use it as the first diagnostic step when a preauth is rejected for a coverage mismatch.
  • Store payerId, memberId, productId, productName and policyNumber from the result; these feed x-hcx-recipient_code, the Coverage and Patient identifiers and the InsurancePlan lookup.
  • If the lookup yields nothing, fall back to a coverage-eligibility check with purpose discovery to obtain the active policy code.
  • Keep the token fresh; retry once on 401.

Related scenario

A TPA has just linked a new member through /v2/participant/link/abha/policy and wants to verify the write before closing the ticket. It calls /v2/participant/get/policies with identifiertype AbhaNumber and the member's hyphen-free ABHA number and sees the product returned. Months later the same member is admitted; the hospital's HMIS runs the identifier cascade (ABHA, then member ID, then mobile) against this endpoint, caches the result, and proceeds to /v1/insuranceplan/request and /v1/preauth/submit addressed to the TPA's participant code taken from processingID.

Specification

Chapter Creating and updating a participant of the NHCX integration specification.

Authorizations

bearer_authapiKeyRequired

Every NHCX call carries the access token from the session call in a header named bearer_auth, as the word Bearer, a space and the token. NHCX reads bearer_auth, not Authorization.

Example Bearer <access token>

Headers

AcceptstringRequired

Always application/json on the participant service.

Body

identifiertypestring
identifiervaluestring

Responses

200

Returns HTTP 200 with ParticipantListResponse (optional participantdetails array of participantcode, participantname, address, state).

participantdetailsobject[]
participantdetails.participantcodestring
participantdetails.participantnamestring
participantdetails.addressstring
participantdetails.statestring