Skip to main content
POST
Check Eligibility

Authorizations

Authorization
string
header
required

The API requires a Bearer token (JWT) for authentication.

Headers

X-Pt-Id
string

Eka User ID (OID)

X-Partner-Pt-Id
string

Partner User ID

X-Hip-Id
string

Partner HIP ID

Path Parameters

policyId
integer
required

policy_id from Search Policies or Policy Discovery Status

Required range: x >= 0

Response

OK

auth_requirements
any
cached
boolean

True when this response came straight from EligibilityCache. It is false when this call just submitted a fresh NHCX coverage-eligibility check instead — see RequestID/Message in that case.

fetched_at
string<date-time>
member_id
string
message
string
policy_in_force
boolean
product_id
string
request_id
string
wallet_balance
number