Skip to main content

ClaimResponse

The possible results of querying for a claim.

union ClaimResponse = BadRequestError | Claim | InternalServerError

Possible types​

ClaimResponse.BadRequestError object​

Returned when there is an error in the request.

ClaimResponse.Claim object​

A request from an Individual to be reimbursed from a Benefit for an expense they paid. Amounts describe the expense and the eligible portion of it; they are not a record of payments.

Errors returned by claim operations carry one of these codes:

  • NOT_FOUND: the claim, Individual, Benefit, or document group does not exist or belongs to another partner.
  • FEATURE_NOT_ENABLED: claims, or the requested operation, are not enabled for this partner.
  • FORBIDDEN: the credential is not permitted to perform the operation.
  • INVALID_CLAIM_STATUS: the claim's current status does not allow the operation.
  • LINKED_BANK_ACCOUNT_REQUIRED: the Individual has no verified primary linked bank account that is ready to use; an account that must be relinked does not qualify.
  • BAD_REQUEST: the input is not valid, or a claim rule rejected it, such as a date outside the Benefit's claim period. The message describes the problem.
  • INTERNAL_SERVER_ERROR: an unexpected error occurred.

ClaimResponse.InternalServerError object​

Returned when an error is encountered that is not expected.

Returned By​

claim query