QUICKSTART
API Quick Start
Authentication
SignString
Rate Limit
Body Envelope
Request Errors
CHANGELOG
Changelog
Reference
API Overview
v1
Claims
Query claims
get
Get a claim
get
Coverages
Query coverages
get
Create a coverage
post
Get a coverage
get
Update a coverage tracking info
post
Void a coverage
post
Calculate the premium
post
Model
Envelope
Meta
v1
Error
v1
Pagination
v1
Primitive
Address
v1
Amount
v1
Order Item
v1
Tracking
v1
Resource
Coverage
v1
Claim
v1
Enum
Coverage Status
Courier Slug
Support
Contact Support

Claim

id
string

claim id

>= 1 characters
number
string

claim number from insurance supplier

>= 1 characters
Example:
412-231-231
coverage_id
string

coverage id that this claim is associated with

>= 1 characters
status
string

claim status

>= 1 characters
Allowed values:
unsubmittedsubmittedunder_reviewapprovedpaidcloseddeniedwaiting_on_documents
resolve_status
string

resolve status of the claim

>= 1 characters
Allowed values:
precheckto_be_resolveddeniedresolved
resolved_resolution_method
string

resolution method selected for the claim

Allowed values:
refund_to_original_payment_methodrefund_to_store_creditreship_the_same_itemsother
resolved_resolution_detail
string

details on resolution method when resolved_resolution_method is 'other'

customer_resolution_method
string

resolution method expected by the customer

Allowed values:
refund_to_original_payment_methodrefund_to_store_creditreship_the_same_itemsother
customer_resolution_detail
string

details on resolution method expected by the customer when customer_resolution_method is 'other'

created_at
string

created time in ISO8601 format

>= 1 characters
Example:
2023-03-13T08:16:40.207Z
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

updated time in ISO8601 format

>= 1 characters
Example:
2023-08-15T03:40:12.628Z
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$
issue_type
string

type of issue for the claim

Allowed values:
lost_in_transitporch_pirateddamaged
issue_desc
string

description of the issue

issue_commodity
string

the category of the claimed items

claim_items
array[Order Item]

items being claimed

source_id
string
required

A globally-unique identifier for the item.

title
string
required

Name of the product

>= 1 characters
quantity
integer
required

Quantity of the item in order

unit_insured_amount
Amount
required

Indicate the insured amount for each individual item

sku
string

SKU of the product item

>= 1 characters
image_urls
array[string]

item image urls

claim_items_amount
Amount
amount
string
required
Example:
12.34
Match pattern:
^[0-9.]+$
currency
string
required

Only support USD for now

>= 3 characters<= 3 characters
Example:
USD
Match pattern:
^[A-Z]{3}$
shipping_amount
Amount
claim_submit_amount
Amount
uploaded_documents
array[object]

supporting documents

file_name
string

name of the uploaded document

created_at
string

created time in ISO8601 format

>= 1 characters
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$
url
string

URL of the uploaded document

url_expired_at
string

expiration time of the URL in ISO8601 format

>= 1 characters
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$
required_document_types
array[string]

types of documents required for the claim approval process

claim_payment_amount
Amount
paid_at
string

time payment was made for the claim in ISO8601 formatShow all...

>= 1 characters
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...