Validate Address

The Validate Address endpoint returns valid address suggestions based on the provided input address.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

country

string

required

The name of the country associated with the address (Max 50 characters). This field is required.

state

string

required

The state associated with the address (Max 100 characters). This field is required.

zip

string

required

The ZIP code of the address (Max 20 characters). This field is required.

isPartial

boolean

required

Indicates whether country, city, or street fields are mandatory.

city

string

optional

The name of the city associated with the address (Max 100 characters).

county

string

optional

The county associated with the address (Max 100 characters).

street

string

optional

The street address (Max 200 characters).

region

string

optional

Region of address - Only addresses outside the US (Max 100 characters).

Responses

🟢200Successful operation

application/json

Body

Response schema for matched address results.

requestAddress

object

required

The original address provided in the request.

city

string

optional

The city name (Max 100 characters).

<= 100 characters

country

string

required

The country name (Max 50 characters).

<= 50 characters

state

string

required

The state name (Max 100 characters).

<= 100 characters

zip

string

required

The ZIP code (Max 20 characters).

<= 20 characters

county

string

optional

The county name (Max 100 characters).

<= 100 characters

street

string

optional

The street name (Max 200 characters).

<= 200 characters

region

string

optional

The region name, only for non-US addresses (Max 100 characters).

<= 100 characters

isPartial

boolean

required

Indicates whether partial address data is allowed.

createdDate

string <date-time>

required

The date and time the document was created.

matchedAddresses

array [object {2}]

required

A list of matched addresses based on the request.

address

object

required

The matched address details.

scoring

object

required

Scoring details for the matched address.

Examples

SuccessSuccess

{
    "matchedAddresses": [
        {
            "address": {
                "city": "Phoenix",
                "country": "United States",
                "county": "Maricopa",
                "state": "Arizona",
                "street": "S 3rd Ave",
                "zip": "85041-5705",
            },
            "scoring": {
                "matchLevel": "EXCELLENT",
                "score": 0.96,
                "fieldScore": {
                    "countryMatch": "EXACT",
                    "stateMatch": "EXACT",
                    "cityMatch": "EXACT",
                    "streetMatch": "GOOD",
                    "zipMatch": "EXACT"
                }
            }
        },
        {
            "address": {
                "city": "Phoenix",
                "country": "United States",
                "county": "Maricopa",
                "state": "Arizona",
                "street": "S 3rd St",
                "zip": "85042-4206"
            },
            "scoring": {
                "matchLevel": "EXCELLENT",
                "score": 0.92,
                "fieldScore": {
                    "countryMatch": "EXACT",
                    "stateMatch": "EXACT",
                    "cityMatch": "EXACT",
                    "streetMatch": "GOOD",
                    "zipMatch": "GOOD"
                }
            }
        }
    ],
    "requestAddress": {
        "city": "Phoenix",
        "country": "USA",
        "state": "Arizona",
        "street": "6001 W 3rd St",
        "zip": "85041-5705",
        "isPartial": false
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🔴500Internal Error

Request

Request samples

Responses