Перейти к основному содержанию
POST
Python
Предпросмотр не меняет сессию и не отправляет письмо. После проверки ответа подтвердите с помощью Обновление статуса сессии и передайте возвращённый preview_token в поле email_preview_token. Срок действия квитанции истекает через 15 минут. Если квитанция изменилась или истекла, API возвращает 409 до того, как сессия изменится или письмо будет отправлено. После конфликта создайте новый предпросмотр. Существующие API-интеграции могут не передавать квитанцию: при подтверждении предпросмотра её передаёт консоль. Отправитель и брендинг соответствуют вашей конфигурации White label. Содержимое письма берётся из переведённого шаблона верификации: произвольные темы, тексты писем и URL-адреса действий как входные данные шаблона не принимаются.

Кто получает письмо

email_address необязателен. Если его не передать, письмо уходит на собственный адрес человека: тот, который он подтвердил на шаге проверки электронной почты в сценарии, а если в рамках этого шага адрес не был подтверждён, то адрес из contact_details, указанный при создании сессии. Адрес, переданный в email_address, имеет приоритет. recipient_source показывает, какой адрес применяется:

Отправится ли письмо

will_be_sent равно true, если при подтверждении повторной отправки с send_email: true письмо действительно отправляется. Если значение false, not_sent_reason объясняет причину:

Подтвердите повторную отправку

Вызовите Обновление статуса сессии со следующими полями: Поле language в ответе указывает язык письма: если запрошенный язык недоступен, письмо пишется на английском.

Повторная отправка только на бэкенде

Когда все шаги для повторной отправки выполняются без участия человека (AML, Проверка по базам данных или анализ IP), сессию можно повторно отправить для этого человека не чаще одного раза в 30 секунд. В этом окне предпросмотр возвращает 429, как и Обновление статуса сессии, а время ожидания указано в заголовке Retry-After.

Связанное

Авторизации

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.

Параметры пути

sessionId
string<uuid>
обязательно

UUID сессии верификации для обновления. Принимает ID сессий как пользователей (KYC), так и компаний (KYB) — сервис сопоставляет ID для обоих типов сессий.

Пример:

"11111111-2222-3333-4444-555555555555"

Тело

application/json
nodes_to_resubmit
object[]

Шаги для предварительного просмотра с использованием тех же правил валидации, выбора и порядка выполнения сценария, что и при повторной подаче. Опустите, чтобы автоматически выбрать записанные попытки, требующие повторной подачи.

email_address
string<email>

Необязательно. Отправить электронное письмо на этот адрес вместо собственного адреса человека. Без него получателем является адрес, который человек подтвердил в сценарии, либо адрес, указанный в contact_details. Этот вызов не отправляет электронное письмо.

Пример:

"user@example.com"

email_language
string
по умолчанию:en

Язык для письма с уведомлением. На уровне схемы принимается любая строка; для неподдерживаемых кодов без уведомления используется английский (en).

Пример:

"en"

Ответ

Только предварительный просмотр. Сессия остаётся без изменений, письмо не отправляется.

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

Адрес, на который отправляется электронное письмо. Пустая строка, если адрес человека неизвестен: в этом случае письмо отправить нельзя, и preview_token также пуст. Передайте его как email_address при подтверждении.

Пример:

"person@example.com"

recipient_source
enum<string>
обязательно

Источник значения recipient. request: переданный вами email_address. email_verification: адрес, подтвержденный пользователем на шаге проверки электронной почты сценария. contact_details: адрес, указанный в contact_details при создании сессии. Пустая строка, если адрес отсутствует.

Доступные опции:
email_verification,
contact_details,
request,
Пример:

"email_verification"

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

Заголовок From, с которым отправляется электронное письмо.

Пример:

"Example App <no-reply@mail.example.com>"

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

Отображаемая часть имени в sender.

Пример:

"Example App"

sender_email
string<email>
обязательно

Часть адреса sender.

Пример:

"no-reply@mail.example.com"

sender_kind
enum<string>
обязательно

customer: письмо отправляется с подтверждённого домена отправителя вашего приложения (White label). didit: отправляется с собственного отправителя Didit.

Доступные опции:
customer,
didit
Пример:

"customer"

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

Тема письма в точности так, как она отправляется.

Пример:

"Action Required: Complete your verification in Example App"

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

HTML письма точно в том виде, в котором оно отправляется, со встроенным логотипом в формате data URL. Отображайте его в изолированном фрейме (sandbox), ни в коем случае не напрямую в DOM вашего приложения.

Пример:

"<!DOCTYPE html><html><body>...</body></html>"

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

Текст письма в виде обычного текста, как он хранится в цепочке сообщений пользователя, для компактного предварительного просмотра (в качестве получаемого письма остаётся HTML).

Пример:

"Almost there\n\nSome steps need to be completed again.\nHere’s what to fix:\n\nhttps://verify.didit.me/session/abc123"

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

Язык, на котором составлено письмо. Английский (en), если запрошенный email_language недоступен.

Пример:

"en"

will_be_sent
boolean
обязательно

Отправляет ли подтверждение изменения с помощью send_email: true это электронное письмо. Значение false, если задан not_sent_reason.

Пример:

true

not_sent_reason
enum<string> | null
обязательно

Причина, по которой подтверждение не приведёт к отправке электронного письма, или null, если письмо будет отправлено. no_user_action: каждый выбранный шаг выполняется без участия человека, поэтому повторная отправка завершается автоматически и электронное письмо не отправляется. no_recipient: адрес человека неизвестен, и вы его не передали. sandbox: сессия в песочнице, получатель которой не дал согласие на доставку тестовых электронных писем, поэтому отправка только имитируется.

Доступные опции:
no_user_action,
no_recipient,
sandbox,
null
Пример:

null

nodes_to_resubmit
object[]
обязательно
requires_user_action
boolean
обязательно

Требует ли хотя бы одна выбранная проверка взаимодействия с пользователем. Это не предопределяет итоговый результат сценария.

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

Подписанная квитанция для этого конкретного письма, действующая в течение 15 минут. Передайте ее как email_preview_token в Обновить статус сессии. Пустая строка, если получатель отсутствует.

Пример:

"eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000"

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