Verify a US address

POST

/addresses/verify

curl --request POST \
  --url https://shipjay.com/api/v1/addresses/verify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "company": "example", "street1": "example", "street2": "example", "city": "example", "state": "example", "zip": "example", "country": "US", "phone": "example", "email": "[email protected]" }'

Returns whether the carrier can deliver to the address and, when it can, the corrected form.

Authorizations

• bearerAuth
  shipments:write

Request Body^required

Media typeapplication/json

object

name

required

string

>= 1 characters <= 100 characters

company

string

<= 100 characters

street1

required

string

>= 1 characters <= 120 characters

street2

string

<= 80 characters

city

required

string

>= 1 characters <= 80 characters

state

required

string

>= 1 characters <= 40 characters

zip

required

string

>= 1 characters <= 20 characters

country

string

default: US >= 2 characters <= 2 characters

phone

string

<= 30 characters

email

string format: email

/^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/

Responses

200

Success.

Media typeapplication/json

object

valid

required

boolean

corrected

required

Any of:

object

object

name

required

string

>= 1 characters <= 100 characters

company

string

<= 100 characters

street1

required

string

>= 1 characters <= 120 characters

street2

string

<= 80 characters

city

required

string

>= 1 characters <= 80 characters

state

required

string

>= 1 characters <= 40 characters

zip

required

string

>= 1 characters <= 20 characters

country

required

string

default: US >= 2 characters <= 2 characters

phone

string

<= 30 characters

email

string format: email

/^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/

null

null

messages

required

Array<string>

Example

{
  "corrected": {
    "country": "US"
  }
}

401

Missing or invalid API key.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: validation unauthenticated forbidden not_found conflict insufficient_funds org_suspended spend_limit rate_limited maintenance not_configured upstream internal

message

required

string

details

object

key

additional properties

any

request_id

required

string

Example

{
  "error": {
    "code": "validation"
  }
}

403

The key lacks the required permission, or the account is suspended.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: validation unauthenticated forbidden not_found conflict insufficient_funds org_suspended spend_limit rate_limited maintenance not_configured upstream internal

message

required

string

details

object

key

additional properties

any

request_id

required

string

Example

{
  "error": {
    "code": "validation"
  }
}

404

The resource does not exist.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: validation unauthenticated forbidden not_found conflict insufficient_funds org_suspended spend_limit rate_limited maintenance not_configured upstream internal

message

required

string

details

object

key

additional properties

any

request_id

required

string

Example

{
  "error": {
    "code": "validation"
  }
}

422

The request is not valid. error.details.issues lists the problems.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: validation unauthenticated forbidden not_found conflict insufficient_funds org_suspended spend_limit rate_limited maintenance not_configured upstream internal

message

required

string

details

object

key

additional properties

any

request_id

required

string

Example

{
  "error": {
    "code": "validation"
  }
}

429

Too many requests. Wait Retry-After seconds.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: validation unauthenticated forbidden not_found conflict insufficient_funds org_suspended spend_limit rate_limited maintenance not_configured upstream internal

message

required

string

details

object

key

additional properties

any

request_id

required

string

Example

{
  "error": {
    "code": "validation"
  }
}