> For the complete documentation index, see [llms.txt](https://docs.terminal.africa/tship/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.terminal.africa/tship/claims.md).

# Claims

The Claims API allows you to create and manage claims on lost or damaged parcels in your shipment.

### The Claim Object

This section describes the different attributes available for a claim.

| Attribute   |          | Description                                                                             |
| ----------- | -------- | --------------------------------------------------------------------------------------- |
| claim\_id   | *string* | Unique reference for claim.                                                             |
| description | *string* | Full description of loss.                                                               |
| insurance   | *string* | Unique reference for insurance linked to claim.                                         |
| metadata    | *object* | Additional context attached to claim.                                                   |
| reason      | *enum*   | Reason for claim. Must be one of ***damage*** or ***lost-in-transit**.*                 |
| signature   | *string* | Base 64 representation of signature for claimant.                                       |
| status      | *enum*   | Status of claim request. Must be one of ***confirmed***, ***pending*** or ***failed***. |
| user        | *string* | Unique identifier for user filing claim.                                                |
| witnesses   | *array*  | Witnesses that can support claim.                                                       |


---

# 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://docs.terminal.africa/tship/claims.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.