Validate Address

Allows merchants and services to validate an address against the configured AddressValidator capability in SiteSettings, fallback uses USPS Address Validation.

POST /commerce/customer/addressvalidation

Error

A valid request URL is required to generate request examples

200

{
  "addressCandidates": [
    {
      "address1": "<string>",
      "address2": "<string>",
      "address3": "<string>",
      "address4": "<string>",
      "addressType": "<string>",
      "cityOrTown": "<string>",
      "countryCode": "<string>",
      "isValidated": true,
      "postalOrZipCode": "<string>",
      "stateOrProvince": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Query Parameters

responseFields · string

limits which fields are returned in the response body

Body

application/json

Address Validation Request

address · object

Show child attributes

Response

200

application/json

Success

Address Validation Response

addressCandidates · object[] | null

Address Candidates

Show child attributes