Перейти к основному содержанию
GET
/
v1
/
validate
Эндпоинт проверки VAT
curl --request GET \
  --url https://vat.cleariflow.com/v1/validate/
{
    "company": {
        "address": "8 RUE DE LONDRES\n75009 PARIS",
        "name": "EURL GOOGLE FRANCE"
    },
    "country": {
        "code": "FR",
        "name": "France"
    },
    "valid": true,
    "vat_number": "FR64443061841"
}

​
Начало работы

​
Базовый URL

https://vat.cleariflow.com/v1/validate/

​
Эндпоинт проверки

Эндпоинт validate требует ваш уникальный API-ключ и номер VAT для проверки: 
https://vat.cleariflow.com/v1/validate/
? api_key = YOUR_UNIQUE_API_KEY
& vat_number = FR64443061841
Успешный запрос возвращает полную информацию о компании, связанной с проверенным номером VAT: 
{
    "company": {
        "address": "8 RUE DE LONDRES\n75009 PARIS",
        "name": "EURL GOOGLE FRANCE"
    },
    "country": {
        "code": "FR",
        "name": "France"
    },
    "valid": true,
    "vat_number": "FR64443061841"
}

​
Параметры запроса

​
api_key
String
обязательно
Ваш уникальный API-ключ. У каждого пользователя уникальные ключи для каждого API Cleariflow, поэтому ключ API проверки VAT не будет работать, например, с API геолокации IP.
​
vat_number
String
обязательно
Номер VAT для проверки.

​
Параметры ответа

Ответ API возвращается в универсальном лёгком формате JSON.
​
vat_number
String
Номер VAT для проверки.
​
valid
Boolean
true, если переданный номер VAT валиден.
​
company
Object
Объект с информацией о компании.
​
company.name
String
Название компании, связанной с номером VAT.
​
company.address
String
Адрес компании, связанной с номером VAT.
​
country
Object
Объект с информацией о стране.
​
country.code
String
Двухбуквенный ISO 3166-1 alpha-2 код страны, связанной с номером VAT.
​
country.name
String
Название страны, связанной с номером VAT.