Vai al contenuto principale
POST
curl
L’anteprima non modifica nulla e non invia nulla. La risposta mostra l’email esattamente come la riceve la persona quando imposti la sessione su Approved o Declined con send_email: true. Indica anche chi la riceve, da chi proviene e se la conferma la invia davvero.

Chi riceve l’email

L’email va all’indirizzo della persona: quello verificato in un passaggio di verifica email del flusso, altrimenti quello indicato in contact_details al momento della creazione della sessione. recipient_source indica quale dei due si applica (email_verification o contact_details). Se la sessione non contiene un indirizzo per la persona, recipient, recipient_source e preview_token sono stringhe vuote e non è possibile inviare alcuna email. L’email viene inviata dal dominio mittente verificato della tua applicazione quando si applica la tua configurazione white label (sender_kind: customer), altrimenti dal mittente di Didit (sender_kind: didit).

Se l’email viene inviata

will_be_sent è true quando la conferma della modifica con send_email: true invia l’email. Quando è false, not_sent_reason indica il motivo:

Conferma la decisione

Chiama Update Session Status con questi campi: La ricevuta scade dopo 15 minuti. Se il destinatario, la lingua, lo stato della sessione, il mittente o l’email sono cambiati dopo l’anteprima, l’aggiornamento restituisce 409 prima che venga modificato qualsiasi dato. Ripeti l’anteprima e conferma con la nuova ricevuta.

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. Accetta sia ID di sessione utente (KYC) sia ID di sessione aziendale (KYB).

Esempio:

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

Corpo

application/json
new_status
enum<string>
obbligatorio

La decisione di cui desideri visualizzare l'anteprima dell'email.

Opzioni disponibili:
Approved,
Declined
Esempio:

"Approved"

email_language
string
predefinito:en

Lingua dell'email, con lo stesso valore predefinito di Aggiorna stato della sessione. Una lingua non offerta ripiega sull'inglese; language nella risposta indica quale viene utilizzata.

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. 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,
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:

"Your verification has been approved 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:

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

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. status_unchanged: la sessione ha già questo stato, quindi l'aggiornamento non modifica nulla e non invia nulla. notification_emails_disabled: la sessione è stata creata senza contact_details.send_notification_emails: true, quindi non viene inviata alcuna email di decisione all'indirizzo indicato in contact_details. no_recipient: non è noto alcun indirizzo per la persona. sandbox: una sessione sandbox il cui destinatario non ha acconsentito alla consegna delle email in sandbox, quindi l'invio viene solo simulato.

Opzioni disponibili:
status_unchanged,
notification_emails_disabled,
no_recipient,
sandbox,
null
Esempio:

null

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