QUICKSTART
API Quick Start
Authentication
SignString
Rate Limit
Body Envelope
Request Errors
CHANGELOG
Changelog
Reference
API Overview
v1
Claims
Create Claim
post
Get a claim
get
Upload Documents
post
Policies
Create Policy
post
Get a policy
get
Update a policy shipment info
post
Calculate Policy Amount
post
Model
Envelope
Meta
v1
Error
v1
Pagination
v1
Primitive
Address
v1
Amount
v1
Product
v1
ContactDetail
v1
Phone
v1
Tracking
v1
Name
v1
Resource
Policy
v1
Claim
v1
Enum
Policy Status
Claim Status
Courier Slug
Webhook
Webhook Overview
Support
Contact Support

Claim

id
string
required

claim ID

>= 1 characters<= 32 characters
external_claim_id
string
required

Claim id provided by the insurer

Example:
43124
policy_id
string
required

policy id

>= 1 characters
status
string
required

claim status

>= 1 characters
Allowed values:
claim_receivedwaiting_on_documentsunder_reviewreviewed_completedclaim_approvedclaim_deniedpaid_payment_info_requestedclaim_paidclaim_closedclaim_withdrawn
Example:
claim_received
created_at
string<date-time>

Created time in ISO8601 format.

>= 1 characters
Example:
2022-12-12T12:23:34.333Z
Match pattern:
^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\.[0-9]{3}Z$
updated_at
string<date-time>

Updated time in ISO8601 format.

Example:
2022-12-12T12:23:34.333Z
Match pattern:
^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\.[0-9]{3}Z$
Example
preparing...