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

Address

type
string

Enum (business residential)

>= 1 characters
Example:
residential
street
string
required

Street address, a complete line

>= 1 characters
Example:
Jones Avenue
street_number
string
required

Street number, e.g. 125

>= 1 characters
Example:
1161
district
string

District name, e.g. South District, Nanshan District

>= 1 characters
Example:
Winston Salem
county
string

County name, e.g. Santa Clara County

>= 1 characters
Example:
Santa Clara County
postal_code
string
required

Postal code / zip code

>= 1 characters
Example:
27101
city
string
required

City name, e.g. San Jose

>= 1 characters
Example:
NC
state
object
required

State object

name
string
required

State name, e.g. California

Example:
New York
code
string
required

State code, ISO 3166-2 standard, e.g. US-CA

Example:
NC
country_region
object
required

Country region object

name
string

Country name

Example:
American
code
string

Country code, ISO 3166-1 alpha 3 standard, e.g. USA

Example:
USA
coordinate
object<email>

Coordinate object

longitude
number

longitude value, e.g. 111.23

latitude
number

latitude value, e.g. 111.23

Example
preparing...