Skip to content
/Validation

Shippo Address API (0.1)

The Shippo Address API

Address book, Address validation, and Address parsing
https://goshippo.com

Download OpenAPI description
address_v2.json
address_v2.yaml
Overview
URL
https://support.goshippo.com/hc
Shippo Support
support@shippo.zendesk.com
Languages
Servers
https://api.goshippo.com

Address Book

Store, retrieve, modify, and delete your address book contacts

Operations

Validation

Check your address is valid before creating shipping labels

Operations

Validate address

Request

Returns validation test results along with a recommended address.
Validates both US and international addresses.

US required combinations
state_province + city_locality + address_line_1
or
address_line_1 + postal_code

International required combinations
city_locality + address_line_1

Security
Shippo_Token
Query
namestring(Name)<= 64 characters

The name of the addressee

Example: name=Wilson
organizationstring(Organization)<= 100 characters

The organization of the addressee

Example: organization=Shippo
address_line_1string(Address Line 1)[ 1 .. 100 ] charactersrequired

The first line of the address

Example: address_line_1=731 Market Street
address_line_2string(Address Line 2)<= 50 characters

The second line of the address

Example: address_line_2=#200
city_localitystring(City Locality)<= 64 characters

The city or locality of the address

Example: city_locality=San Francisco
state_provincestring(State Province)<= 32 characters

The state, province, county, or municipal division

Example: state_province=CA
postal_codestring(Postal Code)<= 16 characters

The postal code or zip code

Example: postal_code=94103
country_codestring(CountryCodeISO2)required

The ISO 3166 country code

Enum"AE""AR""AT""AU""AX""AZ""BA""BD""BE""BG"
Example: country_code=US
curl -i -X GET \
'https://api.goshippo.com/v2/addresses/validate?name=Wilson&organization=Shippo&address_line_1=731%20Market%20Street&address_line_2=%23200&city_locality=San%20Francisco&state_province=CA&postal_code=94103&country_code=US' \
-H 'Authorization: ShippoToken <API_TOKEN>'

Responses

Successful Response

Bodyapplication/json
original_addressobject(OriginalAddress)required
recommended_addressRecommendedAddress (object) or null
Any of:

The recommended address is an address we recommend the consumer to use. The attributes have less constraints all values may be NoneType

analysisobject(Analysis)required
geoGeo (object) or null
Any of:
Response
application/json
{
  "original_address": {
    "address_line_1": "string",
    "address_line_2": "string",
    "city_locality": "string",
    "state_province": "string",
    "postal_code": "string",
    "country_code": "string",
    "name": "string",
    "organization": "string",
    "phone": "string",
    "email": "user@example.com"
  },
  "recommended_address": {
    "address_line_1": "string",
    "address_line_2": "string",
    "city_locality": "string",
    "state_province": "string",
    "postal_code": "string",
    "country_code": "string",
    "name": "string",
    "organization": "string",
    "phone": "string",
    "email": "user@example.com",
    "complete_address": "string",
    "confidence_result": { … }
  },
  "analysis": {
    "validation_result": { … },
    "address_type": "unknown",
    "changed_attributes": [ … ]
  },
  "geo": {
    "latitude": 0,
    "longitude": 0
  }
}

Parser

Convert address strings into a correctly formatted address object

Operations