Vertex Validator API Field References

Read about the fields that you specify in your requests and the ones returned by standalone Vertex Validator.

Input Fields

The following table shows the fields that you can specify in the Validate VAT Number request:

Field	Required	Description
`tax_number`	Yes	Specify the tax number to validate.
`country_code`	Yes	Specify the two-letter ISO country code associated with the tax number.
`country_subdivision_code`	Yes, for Canada	Specify the country subdivision code associated with the tax number. This field is required for Canada. For example, use `CA-QC` for Quebec.
`business_name`	Yes, for Canada	Specify the name of the business associated with the tax number. This field is required for Canada.
`cache_expiry_timeout_days`	No	Specify the maximum age, in days, of cached validation results. Use `0` to perform a real-time validation against the tax authority. For example, a value of `30` allows the service to use validation results cached within the previous 30 days.
`on_error`	No	Specify how the service handles errors returned by external validation services. Use proceed to mark the tax number as invalid. Use `syntax_check` to validate only the tax number format and return the value `tax_number-syntax-considered-valid-but-not-verified` in the `buyer-tax_number-validation-info` response field.

Output Fields

The following fields are returned in the request's response:

Field	Description
`buyer_tax_number_normalized`	Returns the tax number in a standardized format.
`buyer_tax_number_valid`	Indicates whether the tax number was successfully validated.
`buyer_tax_number_format_valid`	Indicates whether the tax number was successfully validated.
`buyer_tax_number_validation_info`	Provides additional information about the validation result and processing outcome.
`name`	Returns the name associated with the tax number, when available from the validation authority. This field is not returned for all countries.
`address`	Returns the address associated with the tax number, when available from the validation authority. This field is not returned for all countries.
`buyer_tax_number_service_cache_timestamp`	Returns the timestamp of the original validation request when a cached validation result is used.
`buyer_tax_number_service_cache_used`	Indicates whether a cached validation result was used instead of performing a real-time validation.