Skip to main content
POST
Preview a resubmission email
Previewing does not change the session or send an email. After reviewing the response, call Update Session Status with the same selected steps, recipient and language, and pass the returned preview_token as email_preview_token. The receipt expires after 15 minutes. A changed or expired receipt returns 409 before the session is changed or an email is sent. Generate a fresh preview after a conflict. Existing API integrations may omit the receipt; the console supplies it when confirming a preview. The sender and branding follow your existing white-label configuration. Message content comes from the translated verification template; arbitrary subjects, message bodies and action URLs are not accepted as template inputs.

Authorizations

x-api-key
string
header
required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is missing, wrong, revoked or expired; 403 means the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Path Parameters

sessionId
string<uuid>
required

UUID of the verification session to update. Accepts both user (KYC) and business (KYB) session IDs — the service resolves the ID across both session types.

Example:

"11111111-2222-3333-4444-555555555555"

Body

application/json
email_address
string<email>
required

Recipient shown in the preview. No email is sent.

Example:

"user@example.com"

nodes_to_resubmit
object[]

Steps to preview, using the same validation, selection and workflow ordering as a resubmission. Omit to auto-select recorded attempts needing resubmission.

email_language
string
default:en

Language for the notification email. Accepts any string at schema level; unsupported codes silently fall back to English (en).

Example:

"en"

Response

Preview only. The session is unchanged and no email is sent.

recipient
string<email>
required
sender
string
required
subject
string
required
html
string
required

Rendered email. Inline image attachments use data URLs for preview.

nodes_to_resubmit
object[]
required
requires_user_action
boolean
required

Whether at least one selected check requires user interaction. This does not predict the final workflow outcome.

preview_token
string
required

Signed confirmation receipt, valid for 15 minutes. Pass it as email_preview_token when confirming the same message.