Skip to main content
POST
Validate an Address
This endpoint is enabled per account. Until it is enabled for yours, it returns 404. Contact us to turn it on.
When a calculation for an address comes to 0 because of where it is, an issue says why: see Addresses and zero tax in the FAQ.

Issue codes

Each issue has a code and params, the values its message is built from. A code always carries the same params keys, so you can write or translate your own message. The wording of message may change. New codes may be added. Treat an unknown code by its severity.

Authorizations

X-API-Key
string
header
required

Body

application/json

Body of POST /addresses/validate.

address
AddressValidationAddress · object
required

The address to validate.

Response

Successful Response

What to do with the address, judged on the address alone. accept: use it as it is. confirm: something about it may be wrong; confirm it, or use suggested_address. fix: it can't be placed; the error issues say why.

Available options:
accept,
confirm,
fix
tax
TaxOutcome · object
required

What a tax calculation does with the address as sent.

object
string
default:address_validation
Allowed value: "address_validation"
suggested_address
SuggestedAddress · object | null

The address with every suggestion applied, when Taxwire suggests a change. The rest of the answer is about the address as you sent it.

issues
AddressIssue · object[]

Everything wrong with, or changed in, the address.