Sales Tax APIUtilities

Verify Address

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

Headers

X-API-KEYstringRequired

Request

This endpoint expects an object.
citystringRequired>=1 character<=64 characters

City or post-town

line1stringRequired>=1 character<=50 characters

the first line of the address (e.g., street, PO Box, or building)

statestringRequired>=1 character<=32 characters
State, province, county or other large territorial division.
zipstringRequired>=1 character<=16 characters
Postal or ZIP code.
countryCodestringOptional>=1 character<=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.

line2stringOptional>=0 characters<=50 characters

the second line of the address, if there is one (e.g., apartment or suite number)

Response

OK
citystring>=1 character<=64 characters

City or post-town

line1string>=1 character<=50 characters

the first line of the address (e.g., street, PO Box, or building)

statestring>=1 character<=32 characters
State, province, county or other large territorial division.
zipstring>=1 character<=16 characters
Postal or ZIP code.
$schemastring or nullformat: "uri"
A URL to the JSON Schema for this object.
countryCodestring or null>=1 character<=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.

line2string or null>=0 characters<=50 characters

the second line of the address, if there is one (e.g., apartment or suite number)

Errors