Saltar al contingut principal
POST
curl
Previsualitzar no canvia res i no envia res. La resposta mostra el correu exactament tal com el rep la persona quan canvies la sessió a Approved o Declined amb send_email: true. També indica qui el rep, qui l’envia i si confirmar-ho l’envia realment.

Qui rep el correu

El correu va a l’adreça pròpia de la persona: la que va verificar en un pas de verificació de correu electrònic del flux o, si no n’hi ha cap, la indicada a contact_details en crear la sessió. recipient_source indica quina s’aplica (email_verification o contact_details). Quan la sessió no té cap adreça per a la persona, recipient, recipient_source i preview_token són cadenes buides i no es pot enviar cap correu. El correu s’envia des del domini remitent verificat de la teva aplicació quan s’aplica la teva configuració de Marca blanca (sender_kind: customer); en cas contrari, s’envia des del remitent de Didit (sender_kind: didit).

Si el correu s’envia

will_be_sent és true quan confirmar el canvi amb send_email: true envia el correu. Quan és false, not_sent_reason indica el motiu:

Confirma la decisió

Crida Update Session Status amb aquests camps: El rebut caduca als 15 minuts. Si el destinatari, l’idioma, l’estat de la sessió, el remitent o el correu han canviat des de la previsualització, l’actualització retorna 409 abans que es canviï res. Torna a previsualitzar i confirma amb el nou rebut.

Continguts relacionats

Autoritzacions

x-api-key
string
header
requerit

La clau d'API de la teva aplicació, des de Developers -> API keys a la Business Console. La clau primària té accés complet. Una clau amb nom pot tenir l'abast limitat: cap, lectura o escriptura per recurs, limitada a determinats fluxos de treball o a sessions aprovades, a una llista d'adreces IP i a una data de caducitat. 401 significa que la clau és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap clau, que la clau no té accés a aquest recurs o acció, o que la sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una ruta de sessió significa que la sessió està fora dels fluxos de treball o estats de la clau. Una clau sense accés a fitxers multimèdia rep els URL d'imatge, vídeo i PDF com a null, i una clau sense permís d'escriptura de sessions rep els enllaços de sessió i els tokens com a null. Consulta https://docs.didit.me/console/api-keys.

Paràmetres de ruta

sessionId
string<uuid>
requerit

UUID de la sessió de verificació. Accepta tant IDs de sessió d'usuari (KYC) com d'empresa (KYB).

Exemple:

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

Cos

application/json
new_status
enum<string>
requerit

La decisió el correu electrònic de la qual vols previsualitzar.

Opcions disponibles:
Approved,
Declined
Exemple:

"Approved"

email_language
string
predeterminat:en

Idioma del correu electrònic, el mateix valor per defecte que a Update Session Status. Un idioma que no s'ofereixi torna a l'anglès; el camp language de la resposta indica quin s'utilitza.

Exemple:

"en"

Resposta

Només previsualització. La sessió no canvia i no s'envia cap correu electrònic.

recipient
string
requerit

L'adreça a la qual s'envia el correu electrònic. Una cadena buida quan no es coneix cap adreça per a la persona: en aquest cas no es pot enviar cap correu electrònic i preview_token també és buit. Envia-la com a email_address en confirmar.

Exemple:

"person@example.com"

recipient_source
enum<string>
requerit

D'on prové recipient. email_verification: l'adreça que la persona ha verificat en un pas de verificació de correu electrònic del flux. contact_details: l'adreça indicada a contact_details en crear la sessió. Una cadena buida quan no hi ha cap adreça.

Opcions disponibles:
email_verification,
contact_details,
Exemple:

"email_verification"

sender
string
requerit

La capçalera From amb què s'envia el correu electrònic.

Exemple:

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

sender_name
string
requerit

La part del nom visible de sender.

Exemple:

"Example App"

sender_email
string<email>
requerit

La part de l'adreça de sender.

Exemple:

"no-reply@mail.example.com"

sender_kind
enum<string>
requerit

customer: el correu electrònic s'envia des del domini de remitent verificat de la teva aplicació (marca blanca). didit: s'envia des del remitent propi de Didit.

Opcions disponibles:
customer,
didit
Exemple:

"customer"

subject
string
requerit

La línia de l'assumpte exactament tal com s'envia.

Exemple:

"Your verification has been approved in Example App"

html
string
requerit

L'HTML del correu electrònic exactament com s'envia, amb el seu logotip incrustat com a URL de dades. Renderitza'l en un frame aïllat (sandbox), mai directament al DOM de la teva aplicació.

Exemple:

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

text
string
requerit

El text del correu electrònic com a text pla, tal com el manté el fil de missatges de la persona, per a una previsualització compacta (l'HTML continua sent el correu electrònic que rep la persona).

Exemple:

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

language
string
requerit

L'idioma en què està escrit el correu electrònic. Anglès (en) quan el email_language que has demanat no s'ofereix.

Exemple:

"en"

will_be_sent
boolean
requerit

Indica si confirmar el canvi amb send_email: true envia aquest correu electrònic. false quan s'ha definit not_sent_reason.

Exemple:

true

not_sent_reason
enum<string> | null
requerit

Per què en confirmar no s'enviaria cap correu electrònic, o null quan s'enviarà. status_unchanged: la sessió ja té aquest estat, per la qual cosa l'actualització no canvia res ni envia res. notification_emails_disabled: la sessió es va crear sense contact_details.send_notification_emails: true, per la qual cosa no s'envia cap correu electrònic de decisió a l'adreça indicada a contact_details. no_recipient: no es coneix cap adreça per a la persona. sandbox: una sessió de sandbox el destinatari de la qual no ha acceptat el lliurament de correus electrònics en sandbox, per la qual cosa l'enviament només es simula.

Opcions disponibles:
status_unchanged,
notification_emails_disabled,
no_recipient,
sandbox,
null
Exemple:

null

preview_token
string
requerit

Justificant signat per a aquesta adreça electrònica exacta, vàlid durant 15 minuts. Passa'l com a email_preview_token a Actualitzar l'estat de la sessió. Una cadena buida quan no hi ha destinatari.

Exemple:

"eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000"

Darrera modificació el 7 de novembre del 2026