Sign in

v1

latestOpenAPI 3.1.02026-07-2277219695.0 KB
Validation

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
get/v2/addresses/validate

Query parameters

namestring

The name of the addressee

Example:Wilson

The name of the addressee

organizationstring

The organization of the addressee

Example:Shippo

The organization of the addressee

address_line_1string required

The first line of the address

Example:731 Market Street

The first line of the address

address_line_2string

The second line of the address. Must be percent encoded when passed as a query parameter (e.g. #200 → %23200).

Example:#200

The second line of the address. Must be percent encoded when passed as a query parameter (e.g. #200 → %23200).

city_localitystring

The city or locality of the address

Example:San Francisco

The city or locality of the address

state_provincestring

The state, province, county, or municipal division

Example:CA

The state, province, county, or municipal division

postal_codestring

The postal code or zip code

Example:94103

The postal code or zip code

country_code'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' required

ISO2 country codes

The ISO 3166 country code

Response

Successful Response