Fields Reference

This topic lists the fields that you can use with the API request.

Request fields

FieldDescription
customer.taxRegistrations.taxRegistrationNumberThis is the Tax ID that the Accelerator will validate. When this value is prefixed (with the country code) and the ID is valid, for example IE12345 and the value in the isoCountryCode field is not specified or is not a valid code, the prefix is used to specify the country that the Tax ID belongs to.
customer.taxRegistrations.taxRegistrationAdditionalIdUse this field to provide an additional Tax ID when you want to validate IDs for countries like Egypt. See Egypt.
customer.taxRegistrations.isoCountryCodeThis is the ISO code that represents the country to which the registration belongs. This is sometimes added to the Tax ID (as a prefix) for countries that require this.
customer.taxRegistrations.taxRegistrationTypeThis is the type of Tax Scheme to which the ID belongs, like VAT. If you specify no value here, the validation is run. If you do add a value, you must specify VAT Registration. This setting can also be configured by Vertex in the background settings during the implementation so it can vary.
validationResult.isValidYou can use this Boolean to skip the validation process. See Turning Off Validation.

Response fields

FieldDescription
isValidBoolean that indicates whether or not the Tax ID is valid. This is usually generated by the service, but it can also be set in the request.
isSyntaxValidIndicates whether the syntax is correct.
validationInfoMore detailed information about the processing.
taxRegistrationNumberNormalizedThe Tax ID in the standardized format.
cachedIndicates whether or not a cached validation was used.
cacheTimestampIf a cached value is returned, this field shows the time that the initial request was sent to the external service.
nameThe name that is associated with the Tax ID. Where available, this is retrieved from the Tax Authority's database.
taxNumberServiceThe name of the service that was used to validate the ID. For example, vies means it was validated using VIES.
freeformAddressThe address that is associated with the Tax ID. Where available, this is retrieved from the Tax Authority's database.
customer.customercode.isBusinessIndicatorIf the Tax ID is valid, this is set to true in the response, indicating that the customer is a business.