> 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/get-insurance.md).
# Get Insurance
Fetch details of a specific insurance.
## /insurance/:insurance\_id
`GET` `https://api.terminal.africa/v1/insurance/:insurance_id`
This endpoint allows you to retrieve details of a specific insurance purchase.
#### Path Parameters
| Name | Type | Description |
| ------------- | ------ | --------------------------------------------------------------------------------------- |
| insurance\_id | String | Unique reference for insurance. Must be provided if ***shipment\_id*** is not provided. |
| shipment\_id | String | Unique reference for shipment. Must be provided if ***insurance\_id*** is not provided. |
#### Headers
| Name | Type | Description |
| ----------------------------------------------- | ------ | -------------------------------- |
| Authorization\* | String | Set value to `Bearer SECRET_KEY` |
| Content-Type | String | Set value to `application/json` |
{% tabs %}
{% tab title="200: OK Insurance retrieved successfully." %}
```javascript
{
"status": true,
"message": "Insurance retrieved successfully",
"data": {
"_id": "637c30e1a32631bd87c2907a",
"amount": 600,
"claim": null,
"currency": "NGN",
"metadata": {
"platform": "octamile",
"reference": "ild52fsgkfs8uu3gr736ikl2fe9s93jn"
},
"parcel": {
"_id": "63429e4a12432be769d4b027",
"description": "sets of electronics package items description",
"items": [
{
"description": "iphone x sets of description testing",
"name": "Iphone x",
"weight": 0.5,
"quantity": 2,
"value": 100000,
"currency": "NGN"
}
],
"metadata": {
"platform": "logistics",
"type": "third_party"
},
"packaging": "PA-05804394376",
"total_weight": 0.5,
"user": "USER-00000000000",
"weight_unit": "kg",
"parcel_id": "PC-09857312356",
"created_at": "2022-10-09T10:11:22.631Z",
"updated_at": "2022-10-09T10:11:22.631Z",
"__v": 0,
"contains_perishables": false,
"total_value": 100000,
"id": "63429e4a12432be769d4b027"
},
"partner_charge": 500,
"shipment": {
"_id": "637c2db2fe4259468a4aaa1d",
"address_to": "AD-03203451781",
"address_from": "AD-97595221861",
"address_return": "AD-97595221861",
"parcel": "PC-09857312356",
"pickup_date": "2022-11-23T02:03:23.553Z",
"shipment_purpose": "personal",
"status": "confirmed",
"user": "USER-00000000000",
"events": [
{
"created_at": "2022-11-22T02:03:23.553Z",
"description": "Shipment arranged by Ada Obi",
"location": "Victoria Island, NG",
"status": "confirmed"
}
],
"shipment_id": "SH-02314736509",
"created_at": "2022-11-22T02:02:26.420Z",
"updated_at": "2022-11-22T02:03:23.556Z",
"__v": 0,
"carrier": "CA-81957188177",
"delivery_arranged": "2022-11-22T02:03:23.553Z",
"delivery_date": "2022-11-23T12:00:23.553Z",
"extras": {
"carrier_tracking_url": "https://www.dhl.com/global-en/home/tracking.html?tracking-id=2604444253",
"commercial_invoice_url": "https://sandbox.terminal.africa/v1/shipments/commercial-invoice/SH-02314736509.pdf",
"reference": "CBJ180121002626",
"shipping_label": {
"imageFormat": "PDF",
"content": "",
"typeCode": "label",
"format": "string",
"url": "https://sandbox.terminal.africa/v1/shipments/label/SH-02314736509.pdf"
},
"shipping_label_url": "https://sandbox.terminal.africa/v1/shipments/label/SH-02314736509.pdf",
"tracking_number": "2604444253",
"tracking_url": "https://sandbox.terminal.africa/v1/shipments/track/SH-02314736509"
},
"metadata": {
"shipment_payload": {
"shipmentTrackingNumber": "2604444253",
"cancelPickupUrl": "https://esb-sandpit.dhl.com/expressapi/shipmentsCBJ180121002626",
"trackingUrl": "https://esb-sandpit.dhl.com/expressapi/shipments/2604444253/tracking",
"dispatchConfirmationNumber": "CBJ180121002626",
"packages": [
{
"referenceNumber": 1,
"trackingNumber": "JD014600004599843881",
"trackingUrl": "https://esb-sandpit.dhl.com/expressapi/shipments/2604444253/tracking?pieceTrackingNumber=JD014600004599843881"
}
],
"documents": [
{
"imageFormat": "PDF",
"content": "",
"typeCode": "label",
"format": "string",
"url": "https://sandbox.terminal.africa/v1/shipments/label/SH-02314736509.pdf"
}
],
"shipmentDetails": [
{
"serviceHandlingFeatureCodes": [
"C"
],
"volumetricWeight": 0.357,
"billingCode": "DSA",
"serviceContentCode": "WPX",
"customerDetails": {
"shipperDetails": {
"postalAddress": {
"postalCode": "--",
"cityName": "Lagos",
"countryCode": "NG",
"addressLine1": "4 Gabaro Street, Victoria Island, Lagos",
"addressLine2": "Lagos"
},
"contactInformation": {
"companyName": "Ada Obi",
"fullName": "Ada Obi"
}
},
"receiverDetails": {
"postalAddress": {
"postalCode": "LS96BE",
"cityName": "Leeds",
"countryCode": "GB",
"addressLine1": "2 Seaforth Avenue",
"addressLine2": "Leeds"
},
"contactInformation": {
"companyName": "Ada Obi",
"fullName": "Ada Obi"
}
}
}
}
],
"warnings": [
"Account not white-listed for this On Demand Delivery service. Please contact your DHL account manager."
]
},
"carrier_shipment": {
"plannedShippingDateAndTime": "2022-11-23T10:03:21GMT+00:00",
"pickup": {
"isRequested": true,
"specialInstructions": [
{
"value": "Please call pickup phone number before arrival."
}
],
"pickupDetails": {
"postalAddress": {
"postalCode": "--",
"cityName": "Lagos",
"countryCode": "NG",
"addressLine1": "4 Gabaro Street, Victoria Island, Lagos",
"addressLine2": "Lagos"
},
"contactInformation": {
"email": "ada.obi@example.com",
"phone": "+2348000000001",
"companyName": "Ada Obi",
"fullName": "Ada Obi"
}
}
},
"productCode": "P",
"localProductCode": "P",
"accounts": [
{
"typeCode": "shipper",
"number": "365030737"
},
{
"typeCode": "payer",
"number": "365030737"
}
],
"valueAddedServices": [],
"customerReferences": [
{
"value": "SH-02314736509",
"typeCode": "CO"
},
{
"value": "SH-02314736509",
"typeCode": "AAO"
}
],
"outputImageProperties": {
"allDocumentsInOneImage": true,
"encodingFormat": "pdf",
"imageOptions": [
{
"templateName": "ECOM26_84_A4_001",
"typeCode": "label",
"isRequested": true
},
{
"templateName": "ARCH_8X4_A4_002",
"isRequested": true,
"typeCode": "waybillDoc"
}
]
},
"customerDetails": {
"buyerDetails": {
"postalAddress": {
"postalCode": "121006",
"cityName": "Lagos",
"countryCode": "NG",
"addressLine1": "12 Oliaya Street, Alausa, Ikeja",
"addressLine2": "--"
},
"contactInformation": {
"email": "support@terminal-app.com",
"phone": "+2348000000001",
"companyName": "Terminal Africa",
"fullName": "Terminal Africa"
}
},
"shipperDetails": {
"postalAddress": {
"postalCode": "--",
"cityName": "Lagos",
"countryCode": "NG",
"addressLine1": "4 Gabaro Street, Victoria Island, Lagos",
"addressLine2": "Lagos"
},
"contactInformation": {
"email": "ada.obi@example.com",
"phone": "+2348000000001",
"companyName": "Ada Obi",
"fullName": "Ada Obi"
}
},
"receiverDetails": {
"postalAddress": {
"postalCode": "LS96BE",
"cityName": "Leeds",
"countryCode": "GB",
"addressLine1": "2 Seaforth Avenue",
"addressLine2": "Leeds"
},
"contactInformation": {
"email": "ada.obi@example.com",
"phone": "+447000000001",
"companyName": "Ada Obi",
"fullName": "Ada Obi"
}
}
},
"content": {
"description": "iphone x sets of description testing",
"packages": [
{
"weight": 0.6,
"dimensions": {
"length": 47,
"height": 1,
"width": 38
}
}
],
"declaredValueCurrency": "NGN",
"declaredValue": 100000,
"incoterm": "DAP",
"isCustomsDeclarable": true,
"unitOfMeasurement": "metric",
"exportDeclaration": {
"lineItems": [
{
"number": 1,
"description": "iphone x sets of description testing",
"price": 50000,
"quantity": {
"value": 2,
"unitOfMeasurement": "2M3"
},
"manufacturerCountry": "NG",
"weight": {
"netValue": 0.5,
"grossValue": 0.5
}
}
],
"invoice": {
"number": "02314736509",
"date": "2022-11-22",
"function": "export",
"totalNetWeight": 0.6,
"totalGrossWeight": 0.6,
"customerReferences": [
{
"typeCode": "CU",
"value": "02314736509"
}
]
}
}
},
"requestOndemandDeliveryURL": true,
"shipmentNotification": [
{
"typeCode": "email",
"receiverId": "ada.obi@example.com"
},
{
"typeCode": "email",
"receiverId": "support@terminal.africa"
}
],
"getOptionalInformation": true,
"onDemandDelivery": {
"deliveryOption": "signatureRelease",
"location": "front door",
"specialInstructions": "--",
"authorizerName": "Ada Obi"
}
},
"carrier_pickup": {
"plannedPickupDateAndTime": "2022-11-23T10:03:21GMT+00:00",
"accounts": [
{
"typeCode": "shipper",
"number": "365030737"
},
{
"typeCode": "payer",
"number": "365030737"
}
],
"customerDetails": {
"shipperDetails": {
"postalAddress": {
"postalCode": "--",
"cityName": "Lagos",
"countryCode": "NG",
"addressLine1": "4 Gabaro Street, Victoria Island, Lagos",
"addressLine2": "Lagos"
},
"contactInformation": {
"email": "ada.obi@example.com",
"phone": "+2348000000001",
"companyName": "Ada Obi",
"fullName": "Ada Obi"
}
},
"receiverDetails": {
"postalAddress": {
"postalCode": "LS96BE",
"cityName": "Leeds",
"countryCode": "GB",
"addressLine1": "2 Seaforth Avenue",
"addressLine2": "Leeds"
},
"contactInformation": {
"email": "ada.obi@example.com",
"phone": "+447000000001",
"companyName": "Ada Obi",
"fullName": "Ada Obi"
}
}
},
"specialInstructions": [
{
"value": "Please call pickup phone number before arrival."
}
],
"shipmentDetails": [
{
"productCode": "P",
"isCustomsDeclarable": true,
"declaredValue": 100000,
"declaredValueCurrency": "NGN",
"packages": [
{
"weight": 0.6,
"dimensions": {
"length": 47,
"height": 1,
"width": 38
}
}
],
"unitOfMeasurement": "metric",
"shipmentTrackingNumber": null
}
]
},
"selected_rate": {
"_id": "637c2dc3dbc6d57c7325abf4",
"amount": 12454.92,
"breakdown": [],
"carrier_logo": "https://ucarecdn.com/dcdd8109-af8c-4057-8104-192be821dd6e/download4.png",
"carrier_name": "DHL Express",
"carrier_rate_description": "EXPRESS 12:00 DOC",
"carrier_reference": "CA-81957188177",
"carrier_slug": "dhl-ng",
"currency": "NGN",
"delivery_address": {
"user": "USER-00000000000",
"city": "Leeds",
"coordinates": {
"lat": 53.809487,
"lng": -1.5072216,
"place_id": "ChIJD53YWnlceUgRsmVRYbUVibA"
},
"country": "GB",
"email": "ada.obi@example.com",
"first_name": "Ada",
"is_residential": true,
"last_name": "Obi",
"line1": "2 Seaforth Avenue",
"line2": "",
"phone": "+447000000001",
"place_id": "ChIJD53YWnlceUgRsmVRYbUVibA",
"state": "Leeds",
"zip": "LS96BE",
"address_id": "AD-03203451781",
"created_at": "2022-10-09T10:13:46.176Z",
"updated_at": "2022-10-09T10:13:46.176Z",
"__v": 0
},
"delivery_date": "2022-11-23T12:00:00.000Z",
"delivery_eta": 2037,
"delivery_time": "within 2 days",
"id": "rate_co6AmqgiGDA8juds",
"insurance_coverage": 0,
"includes_duties": false,
"insurance_fee": 0,
"includes_insurance": false,
"metadata": {
"localProductCode": "T",
"productCode": "T",
"default_parcel": {
"packaging_dimension": {
"length": 47,
"height": 1,
"width": 38
},
"parcel_total_weight": 0.5
},
"address_payload": {
"pickup_address": {
"city": "Victoria Island",
"state": "Lagos",
"country": "NG",
"zip": "--"
},
"delivery_address": {
"city": "Leeds",
"state": "Leeds",
"country": "GB",
"zip": "LS96BE"
}
}
},
"parcel": {
"_id": "63429e4a12432be769d4b027",
"description": "sets of electronics package items description",
"items": [
{
"description": "iphone x sets of description testing",
"name": "Iphone x",
"weight": 0.5,
"quantity": 2,
"value": 100000,
"currency": "NGN"
}
],
"metadata": {
"platform": "logistics",
"type": "third_party"
},
"packaging": {
"_id": "63429e2512432be769d4b01d",
"height": 1,
"length": 47,
"name": "DHL Express Large Flyer",
"size_unit": "cm",
"type": "soft-packaging",
"user": "USER-00000000000",
"weight": 0.1,
"weight_unit": "kg",
"width": 38,
"packaging_id": "PA-05804394376",
"created_at": "2022-10-09T10:10:45.673Z",
"updated_at": "2022-10-09T10:10:45.673Z",
"__v": 0,
"id": "63429e2512432be769d4b01d"
},
"total_weight": 0.5,
"user": "USER-00000000000",
"weight_unit": "kg",
"parcel_id": "PC-09857312356",
"created_at": "2022-10-09T10:11:22.631Z",
"updated_at": "2022-10-09T10:11:22.631Z",
"__v": 0
},
"pickup_address": {
"user": "USER-00000000000",
"city": "Victoria Island",
"coordinates": {
"lat": 6.4263118,
"lng": 3.4184293,
"place_id": "ChIJ1SArPc2KOxARwfjurnR1bXY"
},
"country": "NG",
"email": "ada.obi@example.com",
"first_name": "Ada",
"is_residential": true,
"last_name": "Obi",
"line1": "4 Gabaro Street, Victoria Island, Lagos",
"line2": "",
"phone": "+2348000000001",
"place_id": "ChIJ1SArPc2KOxARwfjurnR1bXY",
"state": "Lagos",
"zip": "--",
"address_id": "AD-97595221861",
"created_at": "2022-10-09T10:12:36.450Z",
"updated_at": "2022-10-09T10:12:36.450Z",
"__v": 0
},
"pickup_eta": 1440,
"pickup_time": "Within 24 hours",
"rate_id": "RT-40467909201",
"used": false,
"user": {
"_id": "000000000000000000000000",
"admin": false,
"carriers": {
"domestic": [
"CA-81957188177",
"CA-07032569055",
"CA-18228854618",
"CA-31377601348",
"CA-71017347351",
"CA-85479996273",
"CA-49411197653",
"CA-19429970231"
],
"international": [
"CA-81957188177",
"CA-85479996273",
"CA-49411197653",
"CA-19429970231",
"CA-42199963340"
],
"regional": [
"CA-81957188177",
"CA-07032569055",
"CA-18228854618",
"CA-31377601348",
"CA-71017347351",
"CA-85479996273",
"CA-49411197653",
"CA-19429970231"
]
},
"company_name": "Acme Stores",
"country": "NG",
"email": "team@example.com",
"first_name": "Ada",
"last_name": "Obi",
"metadata": {
"storeId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"totalShipment": 113,
"totalShipmentAmount": 228267.76,
"totalWalletInflow": 0,
"octa_profile_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
},
"phone": "+2348000000001",
"public_key": "pk_test_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"secret_key": "sk_test_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"wallet": "000000000000000000000000",
"user_id": "USER-00000000000",
"created_at": "2022-06-24T21:35:14.842Z",
"updated_at": "2022-11-22T01:54:14.338Z",
"__v": 1,
"plan": "webflow",
"barred_countries": [],
"country_state": "Lagos",
"referralCode": "REF-00000000000",
"name": "Ada Obi",
"id": "000000000000000000000000"
},
"__v": 0,
"created_at": "2022-11-22T02:02:43.685Z",
"updated_at": "2022-11-22T02:02:43.685Z"
}
},
"rate": "RT-40467909201"
},
"status": "pending",
"user": {
"business_category": "",
"_id": "000000000000000000000000",
"admin": false,
"carriers": {
"domestic": [
"CA-81957188177",
"CA-07032569055",
"CA-18228854618",
"CA-31377601348",
"CA-71017347351",
"CA-85479996273",
"CA-49411197653",
"CA-19429970231"
],
"international": [
"CA-81957188177",
"CA-85479996273",
"CA-49411197653",
"CA-19429970231",
"CA-42199963340"
],
"regional": [
"CA-81957188177",
"CA-07032569055",
"CA-18228854618",
"CA-31377601348",
"CA-71017347351",
"CA-85479996273",
"CA-49411197653",
"CA-19429970231"
]
},
"company_name": "Acme Stores",
"country": "NG",
"email": "team@example.com",
"first_name": "Ada",
"last_name": "Obi",
"metadata": {
"storeId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"totalShipment": 113,
"totalShipmentAmount": 228267.76,
"totalWalletInflow": 0,
"octa_profile_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
},
"phone": "+2348000000001",
"public_key": "pk_test_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"secret_key": "sk_test_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"wallet": "000000000000000000000000",
"user_id": "USER-00000000000",
"created_at": "2022-06-24T21:35:14.842Z",
"updated_at": "2022-11-22T01:54:14.338Z",
"__v": 1,
"plan": "webflow",
"barred_countries": [],
"country_state": "Lagos",
"referralCode": "REF-00000000000",
"name": "Ada Obi",
"id": "000000000000000000000000"
},
"value": 100000,
"insurance_id": "IN-70732333028",
"created_at": "2022-11-22T02:16:01.859Z",
"updated_at": "2022-11-22T02:16:01.859Z",
"__v": 0
}
}
```
{% 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://docs.terminal.africa/tship/insurance/get-insurance.md?ask=&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.