Getting started
Base URL
Calculation endpoint
Thecalculate endpoint requires your unique API key, the country and the price you’d like to check:
Request parameters
Your unique API key. Note that each user has unique API keys for each of Cleariflow APIs, so your VAT Validation API key will not work for as your IP Geolocation API, for example.
The amount that you would like to get the VAT amount for or from.
The two letter ISO 3166-1 alpha-2 code of the country in which the transaction takes place.
The VAT category to use for calculation. Use “standard” for standard VAT rate, or specific categories like “e-books”, “audiobooks”, etc. for reduced rates.
If the amount already has VAT added and you’d like to do the reverse calculation and split out the amount and VAT, set this parameter to true. If this parameter is not explicitly included it will default to false.
Response parameters
The API response is returned in a universal and lightweight JSON format.The amount excluding the VAT.
The sum of the base amount and the VAT, i.e.,
amount_excluding_vat + vat_amount.The calculated amount of VAT.
The category of the purchase, used to determine whether it qualifies for a reduced rate. See below for a list of supported categories.
The VAT rate as a decimal string (e.g., “0.190” for 19%).
Object containing country information.
The two letter ISO 3166-1 alpha-2 code of the country in which the transaction takes place.
The name of the country the VAT is being calculated from.