Use this request to validate that a tax ID number is valid.

To validate an ID, use a GET method and the following URL:

https://{service_url}/api/v2/tax/vat_numbers/{tax-number}/validate/{order_date}/{buyer_name}

where:

{service_url} is the URL of the service's environment.
{tax-number} is the number that you want to validate.
{buyer_name} is the name of the buyer.
{order_date} is the date of the order.

The following example validates the specified Tax ID for a buyer called Murphy and an order date of January 1st 2022:

https://{service_url}/api/v2/tax/vat_numbers/CA123456787/validate?order_date=2022-01-01&buyer_name=Murphy

Details

Type	Value
Endpoint	`/api/v2/tax/vat_numbers/:tax-number/validate`
Method	GET
API Reference	Validate VAT number

Parameters

The following query parameters are available:

Field	Description
`private_token`	Private token.
`tax_number`	The tax ID that you wish to validate.
`country_code`	The code for the country where you wish to validate the number.
`buyer_name`	The name of the buyer.
`order_date`	The date of the order.

Output Parameters

For more information about the fields returned by this request, see Vertex Validator Output Schema.

Response Examples

The following example is a successful response for a valid ID:

{
  "invoice_address": {
    "country": "IE",
  },
  "buyer_name": "IRISH ENTERPRISE",
  "tax_deducted": true,
  "buyer_tax_number_valid": true,
  "buyer_tax_number": "IE6388047V",
  "billing_country_code": "IE"
}

The following example is an successful response for an invalid ID:

{
   "billing_country_code" : null,
   "buyer_tax_number" : "IE1234567X",
   "tax_deducted" : false,
   "buyer_tax_number_valid" : false
}