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

Create Claim

post
/claims

Create a claim.

Request

Body

policy_id
string
required

policy id

>= 1 characters
type
string
required

claim type

>= 1 characters
Allowed values:
StolenLostInTransitDamaged
Default:
LostInTransit
Example:
LostInTransit
products
array[Product]
required
>= 1 items
name
string
required

Name of the product

>= 1 characters
quantity
number
required

Quantity of the product in order

price
Amount
required
sku
string

SKU of the product item

>= 1 characters
images
array[string]
required

product image urls

commodity
string

Commodity of the product

Default:
miscellaneous_other
Example:
miscellaneous_other
description
string
required

Claim description

>= 1 characters
amount
Amount
required
contact_detail
ContactDetail
required
address
Address
required
phone
Phone
email
string
full_name
Name
payee_detail
ContactDetail
required
loss_date
string<date>
required

loss date of products

>= 10 characters<= 10 characters
Example:
2022-02-02
Match pattern:
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
external_customer_id
string
email
string

the email of policy owner, always same as contact_detail.

Auth
:
Body
preparing...