Перейти к основному содержанию
GET
API проверки email

Быстрый старт

Для запроса нужны только ваш уникальный api_key и проверяемый email — больше ничего не требуется:
При успехе запрос возвращает все доступные данные об адресе:

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

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. На всех планах выполняются одинаковые проверки; бесплатные отличаются только месячной квотой и лимитом RPS (см. коды ошибок 422 и 429).
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, если домен принадлежит бесплатному почтовому провайдеру (например, Gmail, Yahoo).
is_disposable_email
Boolean
true, если домен есть в нашем списке одноразовых/временных почтовых сервисов (например, Mailinator, Yopmail).
is_role_email
Boolean
true, если локальная часть выглядит как ролевой аккаунт, а не личный, например team@, sales@, info@.
is_catchall_email
Boolean
true, если домен настроен как catch-all.
is_mx_found
Boolean
true, если для домена существуют MX-записи.
is_smtp_valid
Boolean
true, если SMTP-проверка прошла успешно. При неудаче SMTP, но успехе других проверок результат может быть UNKNOWN. Не рекомендуем блокировать регистрации или отправку форм только из-за ошибок SMTP.

Примеры запросов

Пример: вероятная опечатка

Этот пример показывает запрос, в котором обнаружена вероятная опечатка в переданном адресе. Даже при обнаружении вероятной опечатки все остальные проверки (например, бесплатная почта, одноразовый домен) выполняются для изначально переданного адреса — а не для предложенной коррекции.
Успешный ответ выглядит так:

Пример: неверный формат

Этот пример демонстрирует адрес, не прошедший базовую проверку формата. Когда is_valid_format равен false, последующие проверки (например, is_free_email, is_role_email) пропускаются и возвращаются как false.
Успешный ответ выглядит так:

Массовая загрузка (CSV)

Не хотите вызывать API напрямую? Используйте массовую загрузку CSV — результаты будут отправлены на email после завершения обработки. При загрузке CSV следуйте этим рекомендациям:
  • Размещайте email-адреса в первом столбце.
  • Удалите пустые строки.
  • Используйте один адрес на строку.
  • Ограничьте файлы максимум 50 000 строками.

Коды ответов и ошибок

Ошибки возвращаются в JSON с кодом и понятным описанием. Ниже перечислены распространённые коды.

Прочее

Примечание по тарифам: на всех планах (бесплатных и платных) выполняются одинаковые проверки, включая MX, SMTP и catch-all. Примечание по биллингу: каждый проверенный email расходует один кредит за запрос — независимо от результата. Отправка невалидного адреса (например, «fda3346ds») всё равно считается за один кредит.