> For the complete documentation index, see [llms.txt](https://partner-docs.covergenius.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://partner-docs.covergenius.com/xclaim/integrations/claim-eligibility/get-claim-eligibility-check.md).

# Get Claim Eligibility Check

## Get Claim Eligibility

<mark style="color:blue;">`GET`</mark> `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<mark style="color:red;">\*</mark> | String | e.g. XYZ999        |
| INS<mark style="color:red;">\*</mark>         | String | e.g. SFAD-FVWJ-INS |

**Headers**

| Name                                            | Type   | Description           |
| ----------------------------------------------- | ------ | --------------------- |
| Authorization<mark style="color:red;">\*</mark> | String | Bearer {{JWT\_token}} |

{% tabs %}
{% tab title="200: OK" %}
{% tabs %}
{% tab title="Request" %}

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

**Request Parameters**

| Name                                             | Type          | Description                                                  |
| ------------------------------------------------ | ------------- | ------------------------------------------------------------ |
| quoteReference<mark style="color:red;">\*</mark> | String (UUID) | The quote id to pick which quote to use from the policy data |
| {% endtab %}                                     |               |                                                              |

{% tab title="Claim Eligible True Response" %}
The expected response data if the customer is eligible to create a claim

```json
{
  "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                      |
| {% endtab %}       |         |                                                              |

{% tab title="Claim Eligible False Response" %}
The expected response data if the customer is not eligible to create a claim

```json
{
  "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                            |
| {% endtab %}       |                |                                                              |
| {% endtabs %}      |                |                                                              |
| {% endtab %}       |                |                                                              |

{% tab title="401: Unauthorized" %}
{% tabs %}
{% tab title="Request" %}

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

**Request Parameters**

| Name                                             | Type          | Description                                                  |
| ------------------------------------------------ | ------------- | ------------------------------------------------------------ |
| quoteReference<mark style="color:red;">\*</mark> | String (UUID) | The quote id to pick which quote to use from the policy data |
| {% endtab %}                                     |               |                                                              |

{% tab title="Response" %}
The expected response if the user does not provide a valid credential to access this route.

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

{% endtab %}
{% endtabs %}
{% endtab %}
{% endtabs %}

**Claim Eligibility Rules:**

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

<table><thead><tr><th width="273">Rule</th><th>Description</th></tr></thead><tbody><tr><td>Valid policy coverage period</td><td>Checks whether the time at which the claim eligibility route is called is within the policy coverage period</td></tr><tr><td>Claim with same purchase has unique quote</td><td>Checks that the <code>quote_reference</code> provided in the request data is unique and not used by any other existing claims with the same <code>booking_reference</code>/<code>INS</code></td></tr><tr><td>Customer not in fraudster list</td><td>Verify that the policy holder is not in the fraudster list</td></tr><tr><td>Active booking status</td><td>Verify that the policy data obtained from the <code>INS</code> provided is in an active status</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://partner-docs.covergenius.com/xclaim/integrations/claim-eligibility/get-claim-eligibility-check.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.