Vai al contenuto principale
POST
Python
L’anteprima non modifica la sessione né invia un’email. Dopo aver esaminato la risposta, conferma con Aggiorna stato della sessione e passa il preview_token restituito come email_preview_token. La ricevuta scade dopo 15 minuti. Una ricevuta modificata o scaduta restituisce 409 prima che la sessione venga modificata o che venga inviata un’email. Dopo un conflitto, genera una nuova anteprima. Le integrazioni API esistenti possono omettere la ricevuta; la console la fornisce quando confermi un’anteprima. Il mittente e il branding seguono la tua configurazione White label. Il contenuto del messaggio proviene dal modello di verifica tradotto; oggetti, corpi del messaggio e URL di azione arbitrari non sono accettati come input del modello.

Chi riceve l’email

email_address è facoltativo. Se non lo passi, l’email va all’indirizzo della persona: quello verificato in un passaggio di verifica email del flusso, altrimenti quello indicato in contact_details alla creazione della sessione. Un indirizzo passato in email_address ha la precedenza. recipient_source indica quale indirizzo si applica:

Se l’email viene inviata

will_be_sent è true quando confermare il reinvio con send_email: true invia l’email. Se è false, not_sent_reason spiega il motivo:

Conferma il reinvio

Chiama Aggiorna stato della sessione con questi campi: Il language della risposta è la lingua in cui è scritta l’email: l’inglese, quando quella richiesta non è disponibile.

Reinvii ripetuti solo lato backend

Quando ogni passaggio da reinviare viene eseguito senza la persona (AML, Validazione su database o Analisi IP), una sessione può essere reinviata per lei solo una volta ogni 30 secondi. Entro questo intervallo, l’anteprima restituisce 429, come farebbe Aggiorna stato della sessione, con il tempo di attesa nell’intestazione Retry-After.

Correlati

Autorizzazioni

x-api-key
string
header
obbligatorio

La chiave API della tua applicazione, da Developers -> API keys nella Business Console. La chiave primaria ha accesso completo. Una chiave con nome può avere un ambito definito: nessuno, lettura o scrittura per risorsa, limitata ad alcuni workflow o a sessioni approvate, a un elenco di indirizzi IP e a una data di scadenza. 401 indica che la chiave è errata, revocata o scaduta; 403 indica che non è stata inviata alcuna chiave, che la chiave non ha accesso a questa risorsa o azione, oppure che la richiesta proviene da un indirizzo non incluso nel suo elenco IP; 404 su una route di sessione indica che la sessione non rientra nei workflow o negli stati previsti dalla chiave. Una chiave senza accesso ai media riceve gli URL di immagini, video e PDF come null, e una chiave senza permessi di scrittura sulle sessioni riceve link e token di sessione come null. Consulta https://docs.didit.me/console/api-keys.

Parametri del percorso

sessionId
string<uuid>
obbligatorio

UUID della sessione di verifica da aggiornare. Accetta sia ID di sessione utente (KYC) sia ID di sessione aziendale (KYB): il servizio risolve l'ID per entrambi i tipi di sessione.

Esempio:

"11111111-2222-3333-4444-555555555555"

Corpo

application/json
nodes_to_resubmit
object[]

Passaggi da visualizzare in anteprima, utilizzando le stesse regole di validazione, selezione e ordinamento del workflow di un nuovo invio. Ometti per selezionare automaticamente i tentativi registrati che richiedono un nuovo invio.

email_address
string<email>

Opzionale. Invia l'email a questo indirizzo invece che a quello della persona stessa. In sua assenza, il destinatario è l'indirizzo verificato dalla persona nel workflow, altrimenti quello indicato in contact_details. Nessuna email viene inviata da questa chiamata.

Esempio:

"user@example.com"

email_language
string
predefinito:en

Lingua per l'email di notifica. Accetta qualsiasi stringa a livello di schema; i codici non supportati ripiegano silenziosamente sull'inglese (en).

Esempio:

"en"

Risposta

Solo anteprima. La sessione non viene modificata e non viene inviata alcuna email.

recipient
string
obbligatorio

L'indirizzo a cui viene inviata l'email. Stringa vuota se non si conosce alcun indirizzo per la persona: in tal caso non è possibile inviare alcuna email e anche preview_token è vuoto. Passalo come email_address quando confermi.

Esempio:

"person@example.com"

recipient_source
enum<string>
obbligatorio

Da dove proviene recipient. request: l'email_address trasmesso. email_verification: l'indirizzo verificato dalla persona in un passaggio di verifica email del flusso. contact_details: l'indirizzo fornito in contact_details alla creazione della sessione. Una stringa vuota quando non è presente alcun indirizzo.

Opzioni disponibili:
email_verification,
contact_details,
request,
Esempio:

"email_verification"

sender
string
obbligatorio

L'intestazione From con cui viene inviata l'email.

Esempio:

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

sender_name
string
obbligatorio

La parte del nome visualizzato di sender.

Esempio:

"Example App"

sender_email
string<email>
obbligatorio

La parte relativa all'indirizzo di sender.

Esempio:

"no-reply@mail.example.com"

sender_kind
enum<string>
obbligatorio

customer: l'email viene inviata dal dominio mittente verificato della tua applicazione (white label). didit: viene inviata dal mittente di Didit.

Opzioni disponibili:
customer,
didit
Esempio:

"customer"

subject
string
obbligatorio

La riga dell'oggetto esattamente come viene inviata.

Esempio:

"Action Required: Complete your verification in Example App"

html
string
obbligatorio

L'HTML dell'email esattamente come inviato, con il logo incorporato come data URL. Effettuane il rendering in un frame in sandbox, mai direttamente nel DOM della tua applicazione.

Esempio:

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

text
string
obbligatorio

Il testo dell'email in testo normale, così come viene mantenuto nel thread Messaggi della persona, per un'anteprima compatta (l'HTML rimane l'email ricevuta dalla persona).

Esempio:

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

language
string
obbligatorio

La lingua in cui è scritta l'email. Inglese (en) se l'email_language richiesta non è disponibile.

Esempio:

"en"

will_be_sent
boolean
obbligatorio

Indica se la conferma della modifica con send_email: true comporta l'invio di questa email. false quando not_sent_reason è impostato.

Esempio:

true

not_sent_reason
enum<string> | null
obbligatorio

Il motivo per cui la conferma non invierebbe alcuna email, oppure null se verrà inviata. no_user_action: ogni passaggio selezionato viene eseguito senza la persona, quindi il nuovo invio si completa autonomamente e non viene spedita alcuna email. no_recipient: non è noto alcun indirizzo per la persona e non ne hai passato nessuno. sandbox: una sessione sandbox il cui destinatario non ha acconsentito alla consegna delle email in sandbox, quindi l'invio viene solo simulato.

Opzioni disponibili:
no_user_action,
no_recipient,
sandbox,
null
Esempio:

null

nodes_to_resubmit
object[]
obbligatorio
requires_user_action
boolean
obbligatorio

Indica se almeno un controllo selezionato richiede l'interazione dell'utente. Ciò non prevede l'esito finale del workflow.

preview_token
string
obbligatorio

Ricevuta firmata per questa specifica email, valida per 15 minuti. Inviala come email_preview_token a Update Session Status. Una stringa vuota quando non è presente alcun destinatario.

Esempio:

"eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000"

Ultima modifica il 7 novembre 2026