Saltar al contingut principal
POST
Python
La previsualització no canvia la sessió ni envia cap correu electrònic. Després de revisar la resposta, confirma amb Actualitza l’estat de la sessió i passa el preview_token retornat com a email_preview_token. El comprovant caduca al cap de 15 minuts. Un comprovant modificat o caducat retorna 409 abans que la sessió es canviï o s’enviï cap correu electrònic. Genera una nova previsualització després d’un conflicte. Les integracions d’API existents poden ometre el comprovant; la consola el proporciona en confirmar una previsualització. El remitent i la marca segueixen la teva configuració de marca blanca. El contingut del missatge prové de la plantilla de verificació traduïda; no s’accepten com a entrades de la plantilla assumptes, cossos de missatge ni URL d’acció arbitraris.

Qui rep el correu electrònic

email_address és opcional. Sense aquest camp, el correu electrònic s’envia 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, la que es va indicar a contact_details en crear la sessió. Una adreça que passis a email_address té prioritat. recipient_source indica quina adreça s’aplica:

Si el correu electrònic s’envia

will_be_sent és true quan confirmar la nova tramesa amb send_email: true envia el correu electrònic. Quan és false, not_sent_reason indica el motiu:

Confirma la nova tramesa

Crida Actualitza l’estat de la sessió amb aquests camps: El language de la resposta és l’idioma en què s’escriu el correu electrònic: l’anglès quan l’idioma que has demanat no s’ofereix.

Noves trameses repetides només de backend

Quan tots els passos a reenviar s’executen sense la persona (AML, Validació en bases de dades o Anàlisi d’IP), una sessió només es pot tornar a enviar en nom de la persona una vegada cada 30 segons. Dins d’aquest interval, la previsualització retorna 429, igual que ho faria Actualitza l’estat de la sessió, amb l’espera indicada a la capçalera Retry-After.

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ó que s'ha d'actualitzar. Accepta tant IDs de sessió d'usuari (KYC) com d'empresa (KYB); el servei resol l'ID entre tots dos tipus de sessió.

Exemple:

"11111111-2222-3333-4444-555555555555"

Cos

application/json
nodes_to_resubmit
object[]

Passos que es previsualitzaran, amb la mateixa validació, selecció i ordre del flux de treball que en un reenviament. Omet per seleccionar automàticament els intents registrats que necessiten reenviament.

email_address
string<email>

Opcional. Envia el correu electrònic a aquesta adreça en comptes de la pròpia de la persona. Sense aquest camp, el destinatari és l'adreça que la persona ha verificat al flux o bé la indicada a contact_details. Aquesta crida no envia cap correu electrònic.

Exemple:

"user@example.com"

email_language
string
predeterminat:en

Idioma per al correu electrònic de notificació. Accepta qualsevol cadena a nivell d'esquema; els codis no admesos tornen silenciosament a l'anglès (en).

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. request: el email_address que has proporcionat. 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,
request,
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:

"Action Required: Complete your verification 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:

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

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à. no_user_action: tots els passos seleccionats s'executen sense la persona, de manera que el reenviament acaba sol i no s'envia cap correu electrònic. no_recipient: no es coneix cap adreça per a la persona i no n'has indicat cap. 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:
no_user_action,
no_recipient,
sandbox,
null
Exemple:

null

nodes_to_resubmit
object[]
requerit
requires_user_action
boolean
requerit

Indica si com a mínim una comprovació seleccionada requereix interacció de l'usuari. Això no prediu el resultat final del flux de treball.

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