Skip to main content
GET
Get Claim Request

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

claimId
integer
required

claim_id returned by Create Claim

Required range: x >= 0
correlationId
string
required

request_id from a submit, or correlation_id from Get Claim Requests

Response

OK

approved_amount
null | number
correlation_id
string
created_at
string<date-time>
documents
object[]
error_code
string

ErrorCode / ErrorMessage carry a gateway/payer ProtocolResponse error so the UI can show WHY a request failed, not just that it did.

error_message
string
items
object[]
outcome
string
request_id
integer
Required range: x >= 0
request_meta
any
request_subtype
string

Distinguishes a variant within RequestType that workflow_id cannot (e.g. "cancel"/"enhancement"/"reprocess" within request_type "preauth"/"claim") — and, for request_type "communication", carries the payer's Task.reasonCode (tatquery/grievance/ walletupdate/policychange/additionalinfo), which has no workflow_id at all. Previously unexposed on this summary; see nhcx_api_contract_changes.md.

request_type
string
response_meta
any
status
string
submitted_amount
null | number
updated_at
string<date-time>
workflow_id
string