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

Policy

id
string
required

policy id

>= 1 characters
external_policy_number
string
required

policy id from insurance supplier

>= 1 characters
Example:
412-231-231
status
string
required

policy status

>= 1 characters
Allowed values:
inactiveactivatedclaimingclaim_paidclaim_deniedclaim_closedexpiredvoid
Example:
inactive
policy_detail_url
string
required

URL of the policy detail

>= 1 characters
premium
Amount
required
amount
string
required
Match pattern:
^[0-9.]+$
currency
string
required
>= 3 characters<= 3 characters
Example:
USD
Match pattern:
^[A-Z]{3}$
effective_time
string
required

Effective time of policy, times in ISO8601 format.Show all...

>= 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$
expiration_time
string
required

expiration time of policy, render times in ISO8601 format e.g.: ""created_at"": ""2012-01-01T12:00:00Z""

>= 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
required

Updated time in ISO8601 format.Show all...

>= 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$
created_at
string
required

Created time in ISO8601 format.Show all...

>= 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$
external_customer_id
string
required

Customer ID for identifying customer

<= 32 characters
additional_fields
string

Additional fields for extra information

Example
preparing...