Address Validation

POST/v1/open-api/address/validate
LabelRequiredDescription
Api-KeyApi Key, please log in to the system and find it in My Profile
Api-SecretApi Secret, please log in to the system and find it in My Profile

Entity Types

The address recognition API is currently designed to recognize the following types of entities:

ParameterTypeRequiredDescription
addresses[array]-
city[string]-
state_province_code[string]State shortcode
postal_code[string]-
country_code[string]-
is_residential[boolean]If you send true,this address is residintial.If you send false,this address is commercial
curl -X POST  \
  'https://api.sandbox.shipber.com/v1/open-api/address/validate' \
  -H 'Content-Type:application/json' \
  -H 'Api-Key:2cn1wgmfidytin3jef3b' \
  -H 'Api-Secret:qRBYybjRch7BdTxO5NTyGUd6mBvowNbsjahnAnpdI-BXc5sCrRt15XGr-hc9oY7C' \
  -d '{
    "addresses": [
        "5353 W Imperial Hwy Unit 900"
    ],
    "city": "Los Angeles",
    "state_province_code": "CA",
    "postal_code": "90045",
    "country_code": "US"
}'
{
    "data": {
        "status": "Commercial",
        "original_address": {
            "postal_code": "90045",
            "country_code": "US",
            "state_province_code": "CA",
            "is_residential": "",
            "addresses": ["5353 W Imperial Hwy Unit 900"],
            "city": "Los Angeles",
            "address_classification": "Commercial"
        },
        "matched_address": {
            "postal_code": "90045",
            "country_code": "US",
            "state_province_code": "CA",
            "is_residential": false,
            "addresses": ["5353 W Imperial Hwy Unit 900"],
            "city": "Los Angeles",
            "address_classification": "Commercial"
        }
    },
    "status": ""
}