Fields Reference

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

Request fields

Field	Description
`customer.taxRegistrations.isoCountryCode`	This 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.taxRegistrationNumber`	This 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.taxRegistrationType`	This is the type of Tax Scheme to which the ID belongs, like VAT. You must specify `VAT Registration`. Other values will not work.

Response fields

Field	Description
`isValid`	Boolean that indicates if the Tax ID is valid or not.
`isSyntaxValid`	Indicates whether the syntax is correct.
`validationInfo`	More detailed information about the processing.
`normalizedTaxRegistrationNumber`	The Tax ID in the standardized format.
`cached`	Indicates whether a cached validation was used or note.
`cacheTimestamp`	If a cached value is returned, this field shows the time that the initial request was sent to the external service.
`name`	The name that is associated with the Tax ID. Where available, this is retrieved from the Tax Authority's database.
`freeformAddress`	The address that is associated with the Tax ID. Where available, this is retrieved from the Tax Authority's database.
`customer.customercode.isBusinessIndicator`	If the Tax ID is valid, this will be set to true in the response, indicating that the customer is a business.

Updated 8 days ago