Validate a VAT number

Find out what you can do with our API...


API method to use: validate_vat

Skip to demo

Description


Validate UK V.A.T. registration number.

Check whether a VAT number is in the correct format.

Adding any kind of validation facility to your services, whether it is a website, business application or your own CRM system, helps you to avoid time-wasters who provide you with false information, whilst also helping to keep your database clear of useless and inaccurate information.

Mandatory Parameters


Name Description
api_key or javascript_key Use your API key if invoking server-side. If invoking from the browser via JavaScript, generate a JavaScript key using the javascript_key method.
vat_number Enter a UK V.A.T. number.

Optional Parameters


Name Description
client You can optionally include an identifier for your final client or user. This is logged in your usage log and you will be able to view your usage statistics by client.
output Set to json for a JSON response; the default response is XML. Not applicable to the SOAP API.
callback When using JSON, specify a JSONP wrapper in which the JSON response is to be wrapped.

Returned Values


The XML response is contained within a <validate_vat_res> element.

Name Description
status Returns ok if the operation has succeeded, or error if an error has occurred; Returns the error_code for error details. If the vat number is invalid, the error will be invalid_vat_number.
error_code Returns the error code when the status is error. See below for error codes.
t2a_version_number The current API version number.
credit_used The number of credits used in order to execute the request.
mode Returns normal or test when executed in the free test mode.

Error Codes


See the common error codes. There are no errors which are specific to this method.

Free Test Mode


When operating in the free test mode errors are returned if mandatory parameters are missing, or it returns a dummy data response, in an identical format to a real response.

Note that the mode is returned as test when the method is operating in the free test mode.

Example XML Response



<?xml version="1.0"?>
<validate_vat_res>
  <mode>normal</mode>
  <status>ok</status>
  <t2a_version_number>1.0.0</t2a_version_number>
</validate_vat_res>

Back to Validation

Full API method list

Demo


Enter a VAT number to check if it is valid.