File a claim
Submits an insurance claim for a shipping label.
Parameters
Path Parameters
id
string
Required
Shipping label ID
Request Body
claim_type
string (LOST | THEFT | DAMAGE | MISSING_ITEM)
Required
Type of claim
claim_amount
number
Required
Amount being claimed (cannot exceed insurance value)
description
string
Required
Detailed description of the incident (min 20 chars)
incident_date
string
When the loss or damage happened, ISO 8601 (
2026-08-15 or a full timestamp). Recorded on the claim — carriers ask for it. An unparseable value is ignored rather than failing the claim, so a bad date cannot cost you your filing window.evidence_files
array
URLs to evidence photos/documents
contact
object
Required
proof_of_value_files
array
Up to 20 URLs proving what the goods were worth — a paid receipt, paid invoice or completed online order. Kept separate from
evidence_files because every carrier asks for it separately.proof_of_value_note
string
Written statement for the case where no proof-of-value document can exist. Max 2000 characters.
Returns
201
Claim filed
400
CLAIM_EXISTS — an active claim already exists for this label.INVALID_STATUS — the label is not in a claimable status.EXCEEDS_COVERAGE — claim_amount is above the insured value.NO_TRACKING_NUMBER — the label has no tracking number to claim against.NOT_ELIGIBLE — the shipment does not qualify.NO_ORGANIZATION — the API key is not attached to an organization.
401
Authentication required
404
No such label
Related
Insurance
POST/api/v1/insurances/[id]/claim