Claims
The Claims API allows you to create and manage claims on lost or damaged parcels in your shipment.
This section describes the different attributes available for a claim.
Attribute | Text | 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. |
Last modified 6mo ago