Перейти до основного вмісту
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-ключі для кожного 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.