Validate address

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

SecurityShippo_Token
Request
query Parameters
name
string (Name) <= 64 characters

The name of the addressee

Example: name=Wilson
organization
string (Organization) <= 100 characters

The organization of the addressee

Example: organization=Shippo
address_line_1
required
string (Address Line 1) [ 1 .. 100 ] characters

The first line of the address

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

The second line of the address

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

The city or locality of the address

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

The state, province, county, or municipal division

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

The postal code or zip code

Example: postal_code=94103
country_code
required
string (Country Code)

The ISO 3166 country code

Enum: "AE" "AR" "AT" "AU" "AX" "AZ" "BA" "BD" "BE" "BG" "BH" "BM" "BN" "BR" "BS" "BW" "BY" "CA" "CH" "CL" "CO" "CN" "CY" "CZ" "DE" "DK" "EC" "EE" "EG" "ES" "FI" "FO" "FR" "GB" "GE" "GF" "GG" "GI" "GP" "GR" "GU" "HK" "HR" "HU" "ID" "IE" "IL" "IM" "IN" "IS" "IT" "JE" "JO" "JP" "KR" "KY" "KW" "KZ" "LB" "LI" "LT" "LU" "LV" "MA" "MC" "MD" "ME" "MK" "MO" "MP" "MQ" "MT" "MX" "MY" "NA" "NL" "NO" "NZ" "OM" "PE" "PH" "PL" "PM" "PR" "PT" "PY" "QA" "RE" "RO" "RU" "SA" "SC" "SE" "SG" "SI" "SK" "SM" "SR" "TH" "TN" "TR" "TW" "UA" "US" "UY" "VN" "WE" "YT" "ZA"
Example: country_code=US
Responses
200

Successful Response

422

Unprocessable Entity

5XX

Server Error

get/v2/addresses/validate
Request samples 
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>'
Response samples
application/json
{
  • "original_address": {
    },
  • "recommended_address": {
    },
  • "analysis": {
    },
  • "geo": {
    }
}