Sales Tax APIUtilities

Verify Address

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-50 characters

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

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-50 characters

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

Response

OK
citystring1-64 characters

City or post-town

line1string1-50 characters

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

statestring1-32 characters
State, province, county or other large territorial division.
zipstring1-16 characters
Postal or ZIP code.
$schemastring or nullRead-onlyformat: "uri"
A URL to the JSON Schema for this object.
countryCodestring or null1-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 null0-50 characters

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

Errors