Vertex Validator Fields
Learn about the fields that you specify in your requests and the ones returned by the service.
Input Fields
The following table shows the fields that you can specify in the Validate VAT Number request:
| Field | Details | Description |
|---|---|---|
tax_number | Mandatory | The Tax ID or number that is to be checked. |
country_code | Mandatory | The country where the Tax ID originates. |
country_subdivision_code | Mandatory for Canada. | This is only required for Canada, where it is used to specify the Province such as Quebec. |
business_name | Mandatory for Canada. | This is only required for Canada, where it is used to specify the name of the business who owns the Tax ID. |
cache_expiry_timeout_days | Optional | Validation results can be cached. This setting controls how recent the cached result that is returned is. For example, if it is set to 0, the service will validate the ID against the authority's database in real-time. If it is set to 30, the service will use results cached over the last 30 days. |
on_error | Optional | Controls how the service behaves when an external service returns an error. If you specify proceed, the Tax ID will be marked as invalid. If you specify syntax_check, the ID is marked as valid and the following is returned in the API response: buyer-tax_number-validation-info: "tax_number-syntax-considered-valid-but-not-verified". |
Output Fields
The following fields are returned in the request's response:
| Field | Description |
|---|---|
buyer_tax_number_normalized | Returns a the ID in a standardized format. |
buyer_tax_number_valid | Indicates whether the Tax ID is valid or not. |
buyer_tax_number_format_valid | Indicates whether the syntax is valid. |
buyer_tax_number_validation_info | Provides more detailed about the processing. |
name | The name of the owner of the Tax ID. This is not returned for all countries. |
address | The address of the owner of the Tax ID. This is only returned for some countries. This is not returned for all countries. |
buyer_tax_number_service_cache_timestamp | If a cached value is returned, this field shows the time that the initial request was sent to the external service. |
buyer_tax_number_service_cache_used | Indicates that the cache of Tax IDs was used to verify the number. |
Updated 5 months ago