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

# Insurance

The Insurance API allows you to purchase and manage insurance premiums on parcels included in your shipment.

### The Insurance Object

This section describes the different attributes available for insurance.

| Attribute     | Type       | Description                                                                              |
| ------------- | ---------- | ---------------------------------------------------------------------------------------- |
| amount        | *number*   | Total cost of insurance premium.                                                         |
| claim         | *string*   | Unique reference of claim filed for insurance.                                           |
| currency      | *string*   | Currency of insurance purchase.                                                          |
| insurance\_id | *string*   | Unique reference for insurance.                                                          |
| metadata      | *object*   | Additional context attached to insurance purchase.                                       |
| parcel        | *string*   | Unique reference of parcel linked to insurance purchase.                                 |
| shipment      | *string*   | Unique reference of shipment linked to insurance purchase.                               |
| status        | *enum*     | Purchase status of insurance. Is always one of ***confirmed, pending*** or ***failed.*** |
| transaction   | *string*   | Unique transaction reference for insurance purchase charge.                              |
| value         | *number*   | Total value of items in parcel insured.                                                  |
| created\_at   | *datetime* | Time insurance created.                                                                  |
| updated\_at   | *datetime* | Time insurance last updated.                                                             |


---

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