Перейти к основному содержанию
POST
curl

Интеллектуальное дополнение

Установите enable_enrichment в значение true, чтобы дополнительно запустить анализ адреса электронной почты: оценку риска и историю его утечек данных. Дополнение тарифицируется по $0.05 за запрос по стандартной цене, сверх стоимости самой проверки. Запрос возвращает 403, если на вашем балансе недостаточно средств для его оплаты. Три поля определяют, как действуют сигналы. Каждое из них принимает значение NO_ACTION (по умолчанию) или DECLINE, и каждое применяется только если enable_enrichment имеет значение true. При значении NO_ACTION сигнал по-прежнему возвращается в email.email_intelligence, поэтому вы можете применить собственное правило.

Авторизации

x-api-key
string
header
обязательно

API-ключ вашего приложения из раздела «Разработчикам» -> «API-ключи» в Business Console. Основной ключ имеет полный доступ. Именованный ключ может иметь ограниченную область действия: без доступа, чтение или запись для каждого ресурса, ограничение определенными сценариями или одобренными сессиями, списком IP-адресов и сроком действия. 401 означает, что ключ неверен, отозван или его срок действия истек; 403 означает, что ключ не был передан, у ключа нет доступа к этому ресурсу или действию, либо запрос поступил с адреса вне его списка IP-адресов; 404 на маршруте сессии означает, что сессия не входит в сценарии или статусы ключа. Ключ без доступа к медиа получает URL изображений, видео и PDF как null, а ключ без прав на запись сессий получает ссылки на сессии и токены как null. См. https://docs.didit.me/console/api-keys.

Тело

application/json
email
string<email>
обязательно

Тот же адрес электронной почты, что использовался в соответствующем вызове POST /v3/email/send/. Именно он связывает проверку с отправкой.

Пример:

"alice@example.com"

code
string
обязательно

Одноразовый код (OTP), полученный конечным пользователем: 4–8 цифр, или 4–8 букв/цифр, если при отправке использовался параметр alphanumeric_code: true. Сравнение нечувствительно к регистру.

Maximum string length: 10
Пример:

"123456"

duplicated_email_action
enum<string>
по умолчанию:NO_ACTION

Что делать, если тот же адрес уже использовался и был одобрен другим пользователем (учитываются только ранее одобренные верификации) (другой vendor_data) вашего приложения. DECLINE меняет итоговый status на Declined; NO_ACTION фиксирует риск в email.warnings и заполняет email.matches.

Доступные опции:
NO_ACTION,
DECLINE
breached_email_action
enum<string>
по умолчанию:NO_ACTION

Действие, если адрес фигурирует в известных утечках данных (email.is_breached). DECLINE меняет итоговый status на Declined; NO_ACTION фиксирует риск в email.warnings.

Доступные опции:
NO_ACTION,
DECLINE
disposable_email_action
enum<string>
по умолчанию:NO_ACTION

Что делать, если домен принадлежит провайдеру одноразовой/временной почты (email.is_disposable). DECLINE меняет итоговый status на Declined; NO_ACTION фиксирует риск в email.warnings.

Доступные опции:
NO_ACTION,
DECLINE
enable_enrichment
boolean
по умолчанию:false

Когда true, также выполняет проверку адреса электронной почты (email intelligence): оценку риска и историю утечек. Тарифицируется как одна единица email_intelligence_api за запрос ($0.05 по прайс-листу) в дополнение к собственной цене этого endpoint. Запрос возвращает 403, если ваш баланс не может покрыть списание.

Пример:

false

email_intelligence_score_action
enum<string>
по умолчанию:NO_ACTION

Действие, когда оценка риска при анализе электронной почты превышает порог. DECLINE меняет итоговый status на Declined; NO_ACTION фиксирует сигнал без отклонения. Действует только тогда, когда enable_enrichment имеет значение true.

Доступные опции:
NO_ACTION,
DECLINE
recent_email_breach_action
enum<string>
по умолчанию:NO_ACTION

Действие, когда адрес фигурирует в недавней известной утечке данных. DECLINE меняет итоговый status на Declined; NO_ACTION фиксирует сигнал без отклонения. Применяется только при значении true для enable_enrichment.

Доступные опции:
NO_ACTION,
DECLINE
frequent_email_breach_action
enum<string>
по умолчанию:NO_ACTION

Действие, когда адрес фигурирует во множестве известных утечек данных. DECLINE меняет итоговый status на Declined; NO_ACTION фиксирует сигнал без отклонения. Применяется только при значении true для enable_enrichment.

Доступные опции:
NO_ACTION,
DECLINE
enable_social
boolean
по умолчанию:false

Если true, также запрашивает цифровой след адреса: платформы электронной почты, социальные, профессиональные сети, площадки электронной коммерции и развлекательные сервисы, где он зарегистрирован. Тарифицируется как одна единица email_social за запрос дополнительно к цене самого endpoint.

Пример:

true

email_no_social_presence_action
enum<string>
по умолчанию:NO_ACTION

Действие, когда проверка цифрового следа в соцсетях не находит адрес ни на одной из поддерживаемых платформ. В этом endpoint принимаются только NO_ACTION и DECLINE; REVIEW доступно в одноимённом ключе конфигурации сценария.

Доступные опции:
NO_ACTION,
DECLINE

Ответ

Проверка завершена — неверные коды и отсутствующие верификации также возвращают 200; проверяйте status, а не HTTP-код. Поле email заполняется только при финальных результатах (Approved/Declined), равно null при Failed и отсутствует при Expired or Not Found.

request_id
string<uuid>

При Approved/Declined: id сессии сопоставленной верификации — совпадает с request_id, возвращаемым POST /v3/email/send/. При Failed и Expired or Not Found: случайный разовый UUID, который впоследствии нельзя найти по запросу.

status
enum<string>

Approved — правильный код, отсутствуют отклоняющие риски. Declined — терминальный статус: сработал отклоняющий риск или исчерпан лимит попыток (3). Failed — неверный код, попытки ещё остались. Expired or Not Found — нет ожидающей верификации для этого адреса за последние 5 минут.

Доступные опции:
Approved,
Declined,
Failed,
Expired or Not Found
message
string

Понятное объяснение результата, включая количество оставшихся попыток после неверного ввода кода.

email
object | null

Полный отчёт по электронной почте. Присутствует (не null) только при окончательных результатах (Approved/Declined); null при Failed и отсутствует при Expired or Not Found.

vendor_data
string | null

vendor_data сессии совпавшей верификации. null при Expired or Not Found.

metadata
object | null

metadata сессии совпавшей верификации. null при Expired or Not Found.

created_at
string<date-time>

Временная метка ответа на эту проверку.

Последнее изменение 7 ноября 2026 г.