Skip to navigation
Sales Tax APIUtilities

Verify Address

View as Markdown

Use this endpoint to verify an address prior to doing a cart or creating a order.

Authentication

AuthorizationBearer
This authentication type can be used to directly call the service.
OR
X-API-KEYstring
This authentication type is supported by using the provided API key for the merchant account.

Request

This endpoint expects an object.
citystringRequired1-64 characters

City or post-town

line1stringRequired1-128 characters

the first line of the address (e.g., street, PO Box, or building). Values longer than 50 characters will be automatically truncated.

statestringRequired1-32 characters
State, province, county or other large territorial division.
zipstringRequired1-16 characters
Postal or ZIP code.
countryCodestringOptional1-2 charactersDefaults to US

CountryCode is a string field that represents the ISO 3166-1 alpha-2 code of a country. For example, US for the United States, GB for Great Britain etc. Default and only currently accepted value is US.

line2stringOptional0-128 characters

the second line of the address, if there is one (e.g., apartment or suite number). Values longer than 50 characters will be automatically truncated.

Response

OK
citystring1-64 characters

City or post-town

line1string1-128 characters

the first line of the address (e.g., street, PO Box, or building). Values longer than 50 characters will be automatically truncated.

statestring1-32 characters
State, province, county or other large territorial division.
zipstring1-16 characters
Postal or ZIP code.
$schemastringOptionalRead-onlyformat: "uri"
A URL to the JSON Schema for this object.
countryCodestringOptional1-2 charactersDefaults to US

CountryCode is a string field that represents the ISO 3166-1 alpha-2 code of a country. For example, US for the United States, GB for Great Britain etc. Default and only currently accepted value is US.

line2stringOptional0-128 characters

the second line of the address, if there is one (e.g., apartment or suite number). Values longer than 50 characters will be automatically truncated.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error