> 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.md).

# Get Claim

Returns a single claim by Claim Uuid.

## Get Claim

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

Returns a single claim by Claim Uuid that belongs to the partner.

#### Path Parameters

| Name                                          | Type   | Description       |
| --------------------------------------------- | ------ | ----------------- |
| partnerCode<mark style="color:red;">\*</mark> | String | eg. XYZ999        |
| claimUuid                                     | String | UUID of the claim |

#### 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="404: Not Found " %}
{% tabs %}
{% tab title="Response" %}

```json
{
    "type": "exception",
    "message": "Resource 'Claim' with given UUID fd98bfd5-7702-4ede-afdc-78686b3bdfb8 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>

#### Optional fields

These fields are only returned if they are enabled for your integration.

<table><thead><tr><th width="199.4609375">Field</th><th width="148.765625">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>currency</code></td><td>String</td><td>Three-letter currency code of the claim amount, for example <code>AUD</code>.</td></tr><tr><td><code>amount</code></td><td>String</td><td>Claim amount as a decimal number in a string.</td></tr><tr><td><code>claimDetails</code></td><td>Array</td><td>The details submitted with the claim, one entry per field. The fields available depend on the claim type. Values of personal data fields are <code>null</code> unless your integration is allowed to see them.</td></tr><tr><td><code>ticketInformation</code></td><td>Array or null</td><td>Ticket details. The structure of each entry depends on the claim type.</td></tr></tbody></table>

Example with optional fields:

```
{
    "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"
        },
        "currency": "AUD",
        "amount": "250.000000000000000000",
        "claimDetails": [
            {
                "id": "c1d2e3f4-0000-4000-8000-000000000001",
                "claimId": "fd98bfd5-7702-4ede-afdc-78686b3bdfb9",
                "sectionFieldId": "c1d2e3f4-0000-4000-8000-000000000002",
                "value": "Bag arrived damaged",
                "isConditionallyActive": true,
                "createdAt": "2026-11-04T08:02:32.000000Z",
                "updatedAt": "2026-11-04T08:02:32.000000Z",
                "sectionField": {
                    "id": "c1d2e3f4-0000-4000-8000-000000000002",
                    "name": "description",
                    "type": "string",
                    "required": true,
                    "isInternal": false,
                    "isPii": false,
                    ...
                }
            },
            {
                "id": "c1d2e3f4-0000-4000-8000-000000000003",
                "claimId": "fd98bfd5-7702-4ede-afdc-78686b3bdfb9",
                "sectionFieldId": "c1d2e3f4-0000-4000-8000-000000000004",
                "value": [
                    "c1d2e3f4-0000-4000-8000-000000000005"
                ],
                "isConditionallyActive": true,
                "createdAt": "2026-11-04T08:02:32.000000Z",
                "updatedAt": "2026-11-04T08:02:32.000000Z",
                "sectionField": {
                    "id": "c1d2e3f4-0000-4000-8000-000000000004",
                    "name": "file_final_invoice",
                    "type": "file",
                    "required": false,
                    "isInternal": false,
                    "isPii": false,
                    ...
                }
            }
        ],
        "ticketInformation": [
            { ... }
        ]
    }
}
```


---

# 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.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.
