> 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/claims/get-claim-by-claim-reference.md).

# Get Claim By Claim Reference

Returns a single claim by Claim Reference.

## Get Claim

<mark style="color:blue;">`GET`</mark> `https://api.xclaim.xcover-staging.com/partners/{partnerCode}/claims/{claimReference}`

Returns a single claim by Claim Reference (CLA) that belongs to the partner.

#### Path Parameters

<table><thead><tr><th width="181.7421875">Name</th><th width="132.1953125">Type</th><th>Description</th></tr></thead><tbody><tr><td>partnerCode<mark style="color:red;">*</mark></td><td>String</td><td>eg. XYZ999</td></tr><tr><td>claimReference</td><td>String</td><td>eg. CNVWE-83D8H-CLA</td></tr></tbody></table>

#### Headers

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

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

```json
{
    "data": {
        "id": "fd98bfd5-7702-4ede-afdc-78686b3bdfb9",
        "claimReference": "4TWMV-G8VLC-CLA",
        "bookingReference": "9PAL3-VWCMR-INS",
        "quoteReference": "13f16533-df9e-4095-92af-142134ee43c9",
        "updatedAt": "2026-11-04T18:38:17.000000Z",
        "status": {
            "category": "Submitted"
        },
        "statusCategory": {
            "externalStatus": "SUBMITTED",
            "externalLabel": "We've received your claim"
        }
    }
}
```

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

{% tab title="403: Forbidden" %}
{% tabs %}
{% tab title="Response" %}

```json
{
    "message": "This action is unauthorized."
}
```

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

{% tab title="404: Not Found " %}
{% tabs %}
{% tab title="Response" %}

```json
{
    "message": "Claim not found"
}
```

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

#### Response fields

<table data-search="false"><thead><tr><th>Field</th><th width="144.98828125">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>id</code></td><td>String</td><td>Claim UUID.</td></tr><tr><td><code>claimReference</code></td><td>String</td><td>Claim reference (CLA).</td></tr><tr><td><code>bookingReference</code></td><td>String</td><td>Booking reference (INS).</td></tr><tr><td><code>quoteReference</code></td><td>String</td><td>Quote reference of the policy.</td></tr><tr><td><code>updatedAt</code></td><td>String</td><td>When the claim was last updated, in ISO 8601 format.</td></tr><tr><td><code>status.category</code></td><td>String</td><td><strong>Deprecated.</strong> Legacy status category. Use <code>statusCategory.externalStatus</code>.</td></tr><tr><td><code>statusCategory</code></td><td>Object or null</td><td>Current status of the claim.<br>(see <a href="https://partner-docs.covergenius.com/xclaim/claim-creation-workflows/appendix.md#status-categories--external-statuses">Appendix: Status Categories / External Statuses</a>)</td></tr><tr><td><code>statusCategory.externalStatus</code></td><td>String</td><td>Constant status code for use in your integration.</td></tr><tr><td><code>statusCategory.externalLabel</code></td><td>String</td><td>Customer-friendly text for the status. Display it, but do not use it in logic.</td></tr></tbody></table>

{% hint style="info" %}
**Note**

The exact set of attributes passed may differ from integration to integration. The optional fields are described [here](https://partner-docs.covergenius.com/xclaim/claims/get-claim.md#optional-fields).

Please test before using, and if you require further data you think you are not getting, please talk to the integration team.
{% endhint %}

### V2 Get Claim By Reference (For use with async V2 Claim Submissions)

<mark style="color:blue;">`GET`</mark> `https://api.xclaim.xcover-staging.com/api/v2/partners/{partnerCode}/claims/{claimReference}`

Returns a single claim by Claim Reference (CLA) that belongs to the partner.&#x20;

The difference with V2 is it will return 202 when the claim is not yet processed, and can return with failure reasons if submission ultimately failed. Once a claim is submitted it returns 200 with additional data.

#### Path Parameters

<table><thead><tr><th width="181.7421875">Name</th><th width="132.1953125">Type</th><th>Description</th></tr></thead><tbody><tr><td>partnerCode<mark style="color:red;">*</mark></td><td>String</td><td>eg. XYZ999</td></tr><tr><td>claimReference</td><td>String</td><td>eg. CNVWE-83D8H-CLA</td></tr></tbody></table>

#### Headers

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

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

```json
{
    "data": {
        "id": "fd98bfd5-7702-4ede-afdc-78686b3bdfb9",
        "claim_reference": "4TWMV-G8VLC-CLA",
        "booking_reference": "9PAL3-VWCMR-INS",
        "quote_reference": "13f16533-df9e-4095-92af-142134ee43c9",
        "status": "Submitted",
        "language": "en",
        "is_closed": false,
        "claimant": {
            "first_name": "Jane",
            "last_name": "Citizen",
            "email": "jane.citizen@example.com",
            "phone": "+61 400 000 000",
            "country": "AU"
        }
    }
}
```

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

{% tab title="202: Accepted" %}

{% tabs %}
{% tab title="Response" %}

```json
{
    "data": {
        "claim_reference": "4TWMV-G8VLC-CLA",
    }
}
```

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

{% tab title="403: Forbidden" %}
{% tabs %}
{% tab title="Response" %}

```json
{
    "message": "This action is unauthorized."
}
```

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

{% tab title="404: Not Found " %}
{% tabs %}
{% tab title="Response" %}

```json
{
    "message": "Claim not found"
}
```

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

{% tab title="409: Conflict" %}

{% tabs %}
{% tab title="Response" %}

```json
{
    "data": {
        "claim_reference": "4TWMV-G8VLC-CLA",
        "booking_reference": "9PAL3-VWCMR-INS",
        "quote_reference": "13f16533-df9e-4095-92af-142134ee43c9",
        "processing_status": "failed",
        "failure_reason": "duplicate_claim",
        "failure_details": {
            "message": "A claim with this reference already exists",
            "errors": []
        }
    }
}
```

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

{% tab title="422: Unprocessable Entity" %}

{% tabs %}
{% tab title="Response" %}

```json
{
    "data": {
        "claim_reference": "4TWMV-G8VLC-CLA",
        "booking_reference": "9PAL3-VWCMR-INS",
        "quote_reference": "13f16533-df9e-4095-92af-142134ee43c9",
        "processing_status": "failed",
        "failure_reason": "validation_error",
        "failure_details": {
            "message": "Validation failed",
            "errors": {
                "booking_reference": ["Policy not found for booking reference"],
                "email": ["The email field is required."]
            }
        }
    }
}
```

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


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://partner-docs.covergenius.com/xclaim/claims/get-claim-by-claim-reference.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
