Ctrlk
Contact Us
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get Claim Eligibility Check

This section contains information on how to retrieve the claim eligibility check result

Get Claim Eligibility

GET https://api.xclaim.xcover-staging.com/partners/{partnerCode}/bookings/{INS}/customer-eligibility-check

Checks whether the policy data for the given booking INS is eligible to be used to create a claim.

Path Parameters

Name
Type
Description

partnerCode*

String

e.g. XYZ999

INS*

String

e.g. SFAD-FVWJ-INS

Headers

Name
Type
Description

Authorization*

String

Bearer {{JWT_token}}

{ 
  "quoteReference": "034327ff-3687-4baf-ab25-68c5bdd24c60"
}

Request Parameters

Name
Type
Description

quoteReference*

String (UUID)

The quote id to pick which quote to use from the policy data

The expected response data if the customer is eligible to create a claim

{
  "isCustomerEligible": true,
  "claimAmount": "1000",
  "currency": "USD"
}

Response Fields

Name
Type
Description

isCustomerEligible

Boolean

Result of whether the customer is eligible to create a claim

claimAmount

Float

The benefit amount for the given policy

currency

String

The currency for the claim amount field

The expected response data if the customer is not eligible to create a claim

{
  "isCustomerEligible": false,
  "failedChecks": [
    "valid_policy_coverage_period",
    "claim_with_same_purchase_has_unique_quote"
  ]
}

Response Fields

Name
Type
Description

isCustomerEligible

Boolean

Result of whether the customer is eligible to create a claim

failedChecks

Array<string>

A list of rule checks that failed

{ 
  "quoteReference": "034327ff-3687-4baf-ab25-68c5bdd24c60"
}

Request Parameters

Name
Type
Description

quoteReference*

String (UUID)

The quote id to pick which quote to use from the policy data

The expected response if the user does not provide a valid credential to access this route.

{
  "type": "exception",
  "message": "Failed to authenticate because of bad credentials or an invalid authorization header.",
}

Claim Eligibility Rules:

List of rules to check if the customer is eligible to create a claim.

Rule
Description

Valid policy coverage period

Checks whether the time at which the claim eligibility route is called is within the policy coverage period

Claim with same purchase has unique quote

Checks that the quote_reference provided in the request data is unique and not used by any other existing claims with the same booking_reference/INS

Customer not in fraudster list

Verify that the policy holder is not in the fraudster list

Active booking status

Verify that the policy data obtained from the INS provided is in an active status

PreviousClaim Eligibility

Last updated

Was this helpful?