Vai al contenuto principale
POST
curl

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.

Corpo

application/json
email
string<email>
obbligatorio

Indirizzo email del destinatario. Gli indirizzi non formattati correttamente restituiscono 400; gli indirizzi sintatticamente validi che non possono ricevere posta (convalida DNS/MX non riuscita) restituiscono 200 con status: "Undeliverable".

Esempio:

"alice@example.com"

options
object

Opzioni di formato, localizzazione e branding dell'OTP. Tutti i campi sono facoltativi.

signals
object

Segnali opzionali di dispositivo e rete relativi all'utente finale, inoltrati al livello antifrode per migliorare il rilevamento del traffico abusivo o automatizzato. Tutti i campi sono opzionali.

vendor_data
string

Identificatore opzionale controllato dal chiamante (il tuo ID utente interno, un'email, un UUID, ecc.) memorizzato nella sessione e restituito nella risposta di invio, nella risposta di verifica della corrispondenza, nei webhook e nella Business Console. Usalo per correlare il request_id di Didit con il record del tuo utente.

metadata
object | null

Oggetto JSON a struttura libera opzionale memorizzato nella sessione e restituito nella risposta di invio, nella risposta del controllo di corrispondenza, nei webhook e nella Business Console.

Risposta

Invio confermato. Ispeziona status: Success e Retry indicano che un codice è in arrivo; Undeliverable indica che l'indirizzo non può ricevere posta e la verifica è già finalizzata come Declined. request_id è l'ID di sessione persistente (stesso ID in caso di Retry).

request_id
string<uuid>

ID sessione della verifica. Un invio Retry restituisce lo stesso request_id dell'invio originale. Questo id compare nella Business Console, viene restituito nuovamente da un POST /v3/email/check/ finalizzato e può essere passato a GET /v3/session/{sessionId}/decision/.

status
enum<string>

Success — OTP inviato via email per una nuova verifica (fatturata). Retry — nuovo OTP inviato via email per la verifica in sospeso creata da un invio precedente (gratuito). Undeliverable — l'indirizzo non ha superato la convalida di recapito o non è stato possibile inviare il messaggio; la verifica viene immediatamente finalizzata come Declined e non viene addebitato nulla.

Opzioni disponibili:
Success,
Retry,
Undeliverable
reason
enum<string> | null

email_can_not_be_delivered quando status è Undeliverable; null altrimenti.

Opzioni disponibili:
email_can_not_be_delivered,
null
vendor_data
string | null

Eco del vendor_data memorizzato nella sessione (dal primo invio).

metadata
object | null

Eco dei metadata memorizzati nella sessione (dal primo invio).

Ultima modifica il 7 novembre 2026