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

Авторизации

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>
обязательно

Адрес электронной почты получателя. Некорректные адреса возвращают 400; синтаксически корректные адреса, не способные принимать почту (неудачная проверка DNS/MX), возвращают 200 со значением status: "Undeliverable".

Пример:

"alice@example.com"

options
object

Параметры формата, локализации и брендинга одноразового кода. Все поля необязательны.

signals
object

Необязательные сигналы об устройстве и сети конечного пользователя, передаваемые на уровень защиты от фрода для улучшения обнаружения злоупотреблений или автоматизированного трафика. Все поля необязательны.

vendor_data
string

Необязательный идентификатор, контролируемый вызывающей стороной (ваш внутренний идентификатор пользователя, email, UUID и т. д.), сохраняемый в сессии и возвращаемый в ответе на отправку, ответе проверки соответствия, webhook и Business Console. Используйте его для сопоставления request_id от Didit с вашей записью пользователя.

metadata
object | null

Необязательный JSON-объект в свободной форме, сохраняемый в сессии и возвращаемый в ответе на отправку, в ответе проверки соответствия, в webhook и в Business Console.

Ответ

Отправка подтверждена. Проверьте status: Success и Retry означают, что код в пути; Undeliverable означает, что адрес не может принимать почту и верификация уже завершена со статусом Declined. Поле request_id содержит сохранённый идентификатор сессии (тот же id при Retry).

request_id
string<uuid>

ID сессии верификации. Отправка с Retry возвращает тот же request_id, что и исходная отправка. Этот ID отображается в Business Console, возвращается повторно при завершённом POST /v3/email/check/ и может быть передан в GET /v3/session/{sessionId}/decision/.

status
enum<string>

Success — OTP отправлен по электронной почте для новой верификации (платно). Retry — отправлен новый OTP для ожидающей верификации, созданной предыдущей отправкой (бесплатно). Undeliverable — адрес не прошёл валидацию доставляемости или сообщение не удалось отправить; верификация сразу переводится в статус Declined, средства не списываются.

Доступные опции:
Success,
Retry,
Undeliverable
reason
enum<string> | null

email_can_not_be_delivered, когда status имеет значение Undeliverable; null в противном случае.

Доступные опции:
email_can_not_be_delivered,
null
vendor_data
string | null

Эхо-значение vendor_data, сохранённого в сессии (из первой отправки).

metadata
object | null

Эхо-значение metadata, сохранённого в сессии (из первой отправки).

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