Passer au contenu principal
POST
curl

Autorisations

x-api-key
string
header
requis

La clé API de votre application, issue de Développeurs -> Clés API dans la Business Console. La clé principale dispose d'un accès complet. Une clé nommée peut être restreinte : aucun, lecture ou écriture par ressource, limitée à certains workflows ou aux sessions approuvées, à une liste d'adresses IP et à une date d'expiration. 401 signifie que la clé est incorrecte, révoquée ou expirée ; 403 signifie qu'aucune clé n'a été envoyée, que la clé n'a pas accès à cette ressource ou action, ou que la requête provient d'une adresse hors de sa liste d'IP ; 404 sur une route de session signifie que la session est hors des workflows ou des statuts de la clé. Une clé sans accès aux médias reçoit les URL d'images, de vidéos et de PDF à null, et une clé sans accès en écriture aux sessions reçoit les liens et tokens de session à null. Voir https://docs.didit.me/console/api-keys.

Corps

application/json
email
string<email>
requis

Adresse e-mail du destinataire. Les adresses malformées renvoient 400 ; les adresses syntaxiquement valides mais incapables de recevoir des e-mails (échec de validation DNS/MX) renvoient 200 avec status: "Undeliverable".

Exemple:

"alice@example.com"

options
object

Options de format, de localisation et d'image de marque de l'OTP. Tous les champs sont facultatifs.

signals
object

Signaux d'appareil et de réseau optionnels concernant l'utilisateur final, transmis à la couche antifraude pour améliorer la détection de trafic abusif ou automatisé. Tous les champs sont optionnels.

vendor_data
string

Identifiant optionnel contrôlé par l'appelant (votre identifiant utilisateur interne, un e-mail, un UUID, etc.) persisté sur la session et renvoyé dans la réponse d'envoi, la réponse de vérification de correspondance, les webhooks et la Business Console. Utilisez-le pour corréler le request_id de Didit avec votre dossier utilisateur.

metadata
object | null

Objet JSON libre optionnel conservé sur la session et renvoyé dans la réponse d'envoi, la réponse de vérification de correspondance, les webhooks et la Business Console.

Réponse

Envoi pris en compte. Examinez status : Success et Retry indiquent qu'un code est en cours d'envoi ; Undeliverable signifie que l'adresse ne peut pas recevoir d'e-mails et que la vérification est déjà finalisée en tant que Declined. request_id est l'identifiant de session persistant (même identifiant lors d'un Retry).

request_id
string<uuid>

ID de session de la vérification. Un envoi Retry renvoie le même request_id que l'envoi initial. Cet identifiant apparaît dans la Business Console, est renvoyé à nouveau par un POST /v3/email/check/ finalisé, et peut être transmis à GET /v3/session/{sessionId}/decision/.

status
enum<string>

Success — OTP envoyé par e-mail pour une nouvelle vérification (facturé). Retry — nouvel OTP envoyé par e-mail pour la vérification en attente créée par un envoi précédent (gratuit). Undeliverable — l'adresse n'a pas passé la validation de délivrabilité ou le message n'a pas pu être envoyé ; la vérification est immédiatement finalisée comme Declined et rien n'est facturé.

Options disponibles:
Success,
Retry,
Undeliverable
reason
enum<string> | null

email_can_not_be_delivered lorsque status est Undeliverable ; null dans le cas contraire.

Options disponibles:
email_can_not_be_delivered,
null
vendor_data
string | null

Écho des vendor_data stockées sur la session (depuis le premier envoi).

metadata
object | null

Écho des metadata stockées sur la session (depuis le premier envoi).

Dernière modification le 7 novembre 2026