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

# Carriers

The Carriers API allows you to manage information on available carriers for your account.

### Sender verification requirement

Some carriers require the **pickup (sender) address** to be NIN-verified before booking.

#### How to detect this

* On the **carrier**: `requires_sender_verification`
* On the **rate** (recommended): `requires_sender_verification` - use this when arranging a shipment

When this flag is `true`:

1. Ensure your pickup address has `verified: true` (see Addresses - Sender address verification).
2. Then arrange the shipment as usual.

If you arrange without a verified pickup address, the request fails.

### The Carrier Object

This section describes the different attributes available for a carrier.

| Attribute                      | Type       | Description                                                                                                                              |
| ------------------------------ | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| active                         | *boolean*  | Indicates if carrier is active for an account.                                                                                           |
| available\_countries           | *array*    | List of user countries carrier is available in.                                                                                          |
| carrier\_id                    | *string*   | Unique reference for carrier.                                                                                                            |
| contact                        | *object*   | Contact information for carrier.                                                                                                         |
| domestic                       | *boolean*  | Indicates if the carrier is available for intracity / intrastate delivery.                                                               |
| logo                           | *string*   | URL image of carrier logo.                                                                                                               |
| international                  | *boolean*  | Indicates if the carrier is available for international delivery.                                                                        |
| metadata                       | *object*   | Provide additional information for a carrier.                                                                                            |
| name                           | *string*   | Name of carrier.                                                                                                                         |
| regional                       | *boolean*  | Indicates if the carrier is available for inter-city / inter-state delivery.                                                             |
| requires\_invoice              | *boolean*  | Indicates if printout of commercial invoice is required for pickup.                                                                      |
| requires\_waybill              | *boolean*  | Indicates if printout of waybill is required for pickup.                                                                                 |
| slug                           | *string*   | Unique slug to identify carrier.                                                                                                         |
| supports\_multi\_parcels       | *boolean*  | Indicates if carrier supports multiple parcel shipments.                                                                                 |
| requires\_sender\_verification | boolean    | If `true`, the pickup address must be NIN-verified before booking a shipment with this carrier. Also returned on rates for that carrier. |
| created\_at                    | *datetime* | Time carrier created                                                                                                                     |
| updated\_at                    | *datetime* | Time carrier 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/carrier.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.