Fields Reference

Learn about validation fields to validate tax identification numbers.

These field references describe the fields specified in the Validate Tax Number request.

Input parameters

The following input fields are available:

Field	Type	Required	Description
`tax_number`	String	Yes	The tax number to validate.
`country_code`	String	Yes	The two-letter ISO country code for the tax number.
`country_subdivision_code`	String	Yes, for Canada	The country subdivision code for the tax number. This field is required for Canada. For example, use `CA-QC` for Quebec.
`business_name`	String	Yes, for Canada	The name of the business for the tax number. This field is required for Canada.
`cache_expiry_timeout_days`	Integer	No	The maximum age, in days, of cached validation results. Use `0` to perform 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`	String	No	Specifies 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's format. The service returns `tax_number-syntax-considered-valid-but-not-verified` in the `buyer-tax_number-validation-info response` field.

Output parameters

The following output fields are available:

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 format is valid.
`buyer_tax_number_validation_info`	Returns 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 the service uses a cached validation result.
`buyer_tax_number_service_cache_used`	Indicates whether the service used a cached validation result instead of performing real-time validation.

Updated 16 days ago

Did this page help you?