Validates tax number

Use this request to validate Tax IDs.

Path Params
string
required
length ≤ 256

Tax number - EU VAT number for example. It is possible to provide country code in it (e.g. IE1234567X)

Query Params
string
length between 2 and 2

2-letter ISO country code.

string
length ≤ 6

ISO based code of the principal subdivision - region/province/state...

string
length ≤ 512

Business name, currently supported only by Canadian GST/HST validation service

date-time

Tax point date is used to find out the correct tax configuration for a given moment in time. It also influences the response from Canadian GST/HST validation service.

If not provided, tax_timestamp defaults to the current time. Format is: yyyy-MM-dd'T'HH:mm:ssZZZ.

integer

A number of days to keep the verified tax number in the cache. After this time passes, that tax number will have to be verified online (e.g. using an online validation service) again.

string

Used to control what should happen if an external service is used to validate a number, but it returns an error. Possible values

  • "proceed" (default): Mark the number as invalid.
  • "syntax-check": Mark the number as valid, set buyer-tax_number-validation-info to "tax_number-syntax-considered-valid-but-not-verified".
Response

Language
Credentials
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json