Перейти до основного вмісту
GET
/
v1
API перевірки email
curl --request GET \
  --url https://emailvalidation.cleariflow.com/v1
{
  "email": "jane.doe@acme-corp.com",
  "autocorrect": "",
  "deliverability": "DELIVERABLE",
  "quality_score": 0.85,
  "is_valid_format": {
    "value": true,
    "text": "TRUE"
  },
  "is_free_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_disposable_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_role_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_catchall_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_mx_found": {
    "value": true,
    "text": "TRUE"
  },
  "is_smtp_valid": {
    "value": true,
    "text": "TRUE"
  }
}

​
Швидкий старт

Щоб виконати запит, передайте унікальний api_key і email, який потрібно перевірити — більше нічого не потрібно: 
https://emailvalidation.cleariflow.com/v1/
? api_key = YOUR_UNIQUE_API_KEY
& email = jane.doe@acme-corp.com
Запит виконується успішно і повертає всі доступні дані про адресу: 
{
  "email": "jane.doe@acme-corp.com",
  "autocorrect": "",
  "deliverability": "DELIVERABLE",
  "quality_score": 0.85,
  "is_valid_format": {
    "value": true,
    "text": "TRUE"
  },
  "is_free_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_disposable_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_role_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_catchall_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_mx_found": {
    "value": true,
    "text": "TRUE"
  },
  "is_smtp_valid": {
    "value": true,
    "text": "TRUE"
  }
}

​
Параметри запиту

​
api_key
string
обов'язково
Ваш особистий API-ключ. Ключі прив’язані до конкретного продукту Cleariflow, тому ключ Email Validation не авторизує запити, наприклад, до API геолокації IP.
​
email
String
обов'язково
Email-адреса, яку потрібно перевірити.
​
auto_correct
Boolean
Необов’язковий прапорець для вимкнення автокорекції. Встановіть auto_correct=false, щоб вимкнути її. За замовчуванням увімкнено.

​
Параметри відповіді

Відповіді повертаються у компактному, стандартизованому форматі JSON.
​
email
String
Повторює email, переданий у запиті.
​
auto_correct
String
Запропонована корекція, якщо виявлено ймовірну помилку (наприклад, johnsmith@gmial.com => johnsmith@gmail.com). Порожньо, якщо пропозиції немає.
​
deliverability
String
Оцінка Cleariflow щодо можливості доставки листів на цю адресу. Можливі значення: DELIVERABLE, UNDELIVERABLE, UNKNOWN. На платних планах DELIVERABLE вимагає успішної SMTP-перевірки; якщо MX-записи є, але SMTP не підтвердив скриньку (часто у великих провайдерів), результат UNKNOWN. На безкоштовних планах значення UNKNOWN, окрім явно недоставних адрес (невалідний формат або disposable-домен).
​
quality_score
Float
Десятковий бал від 0 до 0.99, що відображає якість адреси. Disposable-адреси обмежені близько 0.05; без підтвердження SMTP — максимум 0.55.
​
is_valid_format
Boolean
true, якщо адреса відповідає стандартному шаблону local@domain.tld. Відсутні елементи або недопустимі символи дають false.
​
is_free_email
Boolean
true, якщо домен належить безкоштовному email-провайдеру (наприклад, Gmail, Yahoo).
​
is_disposable_email
Boolean
true, якщо домен є у нашому списку одноразових/тимчасових поштових сервісів (наприклад, Mailinator, Yopmail).
​
is_role_email
Boolean
true, якщо локальна частина схожа на рольовий акаунт, а не на особисту адресу, наприклад team@, sales@, info@.
​
is_catchall_email
Boolean
true, якщо домен налаштовано як catch‑all. Доступно лише на платних тарифах; на безкоштовних повертає null/UNKNOWN.
​
is_mx_found
Boolean
true, якщо для домену існують MX-записи. Доступно лише на платних тарифах; на безкоштовних повертає null/UNKNOWN.
​
is_smtp_valid
Boolean
true, якщо SMTP-перевірка успішна. Якщо SMTP не пройшов, але інші перевірки пройшли, результат може бути UNKNOWN. Ми не рекомендуємо блокувати реєстрації або відправку форм лише через помилки SMTP. Доступно лише на платних тарифах; на безкоштовних повертає null/UNKNOWN.

​
Приклади запитів

​
Приклад: ймовірна помилка в написанні

Цей приклад демонструє запит, у якому виявлено ймовірну помилку в переданій адресі. Навіть якщо знайдено ймовірну помилку, усі інші перевірки (наприклад, безкоштовний email, одноразовий домен) виконуються для оригінально переданої адреси — а не для запропонованої корекції. 
https://emailvalidation.cleariflow.com/v1/
? api_key = YOUR_UNIQUE_API_KEY
& email = johnsmith@gmial.con
Успішна відповідь виглядає так: 
{
  "email": "johnsmith@gmial.con",
  "autocorrect": "johnsmith@gmail.com",
  "deliverability": "UNKNOWN",
  "quality_score": 0.4,
  "is_valid_format": {
    "value": true,
    "text": "TRUE"
  },
  "is_free_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_disposable_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_role_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_catchall_email": {
    "value": null,
    "text": "UNKNOWN"
  },
  "is_mx_found": {
    "value": null,
    "text": "UNKNOWN"
  },
  "is_smtp_valid": {
    "value": null,
    "text": "UNKNOWN"
  }
}

​
Приклад: недійсний формат

Цей приклад демонструє адресу, яка не проходить базову перевірку формату. Коли is_valid_format дорівнює false, наступні перевірки (наприклад, is_free_email, is_role_email) пропускаються і повідомляються як false. 
https://emailvalidation.cleariflow.com/v1/
? api_key = YOUR_UNIQUE_API_KEY
& email = johnsmith
Успішна відповідь виглядає так: 
{
  "email": "johnsmith",
  "autocorrect": "",
  "deliverability": "UNDELIVERABLE",
  "quality_score": 0.0,
  "is_valid_format": {
    "value": false,
    "text": "FALSE"
  },
  "is_free_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_disposable_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_role_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_catchall_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_mx_found": {
    "value": false,
    "text": "FALSE"
  },
  "is_smtp_valid": {
    "value": false,
    "text": "FALSE"
  }
}

​
Масове завантаження (CSV)

Не хочете викликати API напряму? Скористайтеся масовим завантаженням CSV — результати будуть надіслані вам на email після завершення обробки. При завантаженні CSV дотримуйтесь цих правил:
  • Розмістіть email-адреси в першому стовпці.
  • Видаліть порожні рядки.
  • Використовуйте одну адресу на рядок.
  • Обмежте файли максимум 50 000 рядками.

​
Коди відповідей і помилок

Помилки повертаються у форматі JSON з кодом і зрозумілим описом. Поширені коди наведено нижче.
CodeTypeDetails
200OKЗапит успішно виконано.
400Bad requestНекоректний або недійсний запит.
401UnauthorizedПомилка автентифікації — зазвичай через відсутній або недійсний API-ключ.
422Quota reachedКвоту вичерпано (наприклад, недостатньо кредитів на безкоштовних тарифах).
429Too many requestsПеревищено ліміт запитів (на безкоштовних тарифах — до 1 запиту/сек).
500Internal server errorНесподівана помилка на нашому боці.
503Service unavailableСервіс тимчасово недоступний.

​
Інші примітки

Примітка щодо тарифікації: кожна перевірена email-адреса списує один кредит за запит — незалежно від результату. Надсилання недійсної адреси (наприклад, «fda3346ds») все одно зараховується як один кредит.