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

Address

street_1
string
required

Street address 1, a complete line

>= 1 characters
Example:
Jones Avenue
street_2
string

Street address 2, a complete line

>= 1 characters
Example:
Jones Avenue
street_3
string

Street address 3, a complete line

>= 1 characters
Example:
Jones Avenue
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
country_region
object
required

Country region object

code
string
required

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

Example:
USA
phone
string
Example:
+14155552671
email
string
Example:
[email protected]
first_name
string
required
Example:
Joe
last_name
string
required
Example:
Smith
Example
{
  "street_1": "1104, South University Avenue",
  "street_2": "",
  "postal_code": "53916",
  "city": "Beaver Dam",
  "state": {
    "name": "Wisconsin"
  },
  "country_region": {
    "code": "USA"
  },
  "phone": "+14155552671",
  "email": "[email protected]",
  "first_name": "Joe",
  "last_name": "Smith"
}