Перейти к основному содержанию
POST
curl
Предпросмотр ничего не меняет и ничего не отправляет. Ответ показывает письмо так, как его получит человек, когда вы устанавливаете для сессии статус Approved или Declined с send_email: true. Он также сообщает, кто получит письмо, от кого оно придёт и отправится ли оно при подтверждении.

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

Письмо отправляется на собственный адрес человека: тот, который он верифицировал на шаге проверки электронной почты в сценарии, а если такой адрес отсутствует, то адрес из contact_details, указанный при создании сессии. recipient_source показывает, какой из них применяется (email_verification или contact_details). Если у сессии нет адреса для этого человека, поля recipient, recipient_source и preview_token содержат пустые строки, и письмо отправить нельзя. Письмо отправляется с проверенного домена отправителя вашего приложения, если применяется ваша конфигурация White label (sender_kind: customer). В остальных случаях оно отправляется от имени Didit (sender_kind: didit).

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

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

Подтвердите решение

Вызовите Update Session Status с этими полями: Квитанция предпросмотра истекает через 15 минут. Если с момента предпросмотра изменились получатель, язык, статус сессии, отправитель или письмо, обновление возвращает 409 до того, как что-либо изменится. Выполните предпросмотр снова и подтвердите решение с новой квитанцией.

Связанные материалы

  • Update Session Status: одобрить или отклонить сессию и отправить письмо.
  • Preview Resubmission Email: вместо этого просмотреть письмо о повторной подаче документов.
  • White label: отправитель и брендинг, которые использует письмо.

Авторизации

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).

Пример:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Тело

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

Решение, электронное письмо по которому вы хотите предварительно просмотреть.

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

"Approved"

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

Язык письма, то же значение по умолчанию, что и у Update Session Status. Если язык недоступен, используется английский; поле language в ответе указывает, какой именно был применён.

Пример:

"en"

Ответ

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

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

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

Пример:

"person@example.com"

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

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

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

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

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

Пример:

"Your verification has been approved in Example App"

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

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

Пример:

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

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

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

Пример:

"Verification Approved\n\nYour identity has been successfully verified with Acme Pay. No further action is needed on your part."

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, если оно будет отправлено. status_unchanged: у сессии уже установлен этот статус, поэтому обновление ничего не меняет и ничего не отправляет. notification_emails_disabled: сессия была создана без contact_details.send_notification_emails: true, поэтому электронное письмо с решением не отправляется на адрес, указанный в contact_details. no_recipient: адрес этого человека неизвестен. sandbox: сессия в песочнице, получатель которой не дал согласие на доставку электронных писем в песочнице, поэтому отправка только имитируется.

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

null

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

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

Пример:

"eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000"

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