Saltar al contingut principal
POST
curl

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.

Cos

application/json
email
string<email>
requerit

Adreça de correu electrònic del destinatari. Les adreces amb un format incorrecte retornen 400; les adreces sintàcticament vàlides que no poden rebre correu (error de validació de DNS/MX) retornen 200 amb status: "Undeliverable".

Exemple:

"alice@example.com"

options
object

Opcions de format, localització i personalització de marca de l'OTP. Tots els camps són opcionals.

signals
object

Senyals opcionals de dispositiu i xarxa sobre l'usuari final, reenviats a la capa antifrau per millorar la detecció de trànsit abusiu o automatitzat. Tots els camps són opcionals.

vendor_data
string

Identificador opcional controlat per qui fa la crida (el teu id d'usuari intern, un correu electrònic, un UUID, etc.) que es manté a la sessió i es retorna a la resposta d'enviament, a la resposta de comprovació de coincidències, als webhooks i a la Business Console. Utilitza'l per correlacionar el request_id de Didit amb el teu registre d'usuari.

metadata
object | null

Objecte JSON opcional de format lliure que es desa a la sessió i es retorna a la resposta d'enviament, a la resposta de la comprovació de coincidència, als webhooks i a la Business Console.

Resposta

Enviament confirmat. Revisa status: Success i Retry indiquen que s'està enviant un codi; Undeliverable significa que l'adreça no pot rebre correu i la verificació ja s'ha finalitzat com a Declined. request_id és l'identificador de sessió persistit (el mateix identificador en un Retry).

request_id
string<uuid>

ID de sessió de la verificació. Un enviament Retry retorna el mateix request_id que l'enviament original. Aquest id apareix a la Business Console, el torna a retornar un POST /v3/email/check/ finalitzat i es pot transmetre a GET /v3/session/{sessionId}/decision/.

status
enum<string>

Success — OTP enviat per correu electrònic a una nova verificació (facturat). Retry — nou OTP enviat per correu electrònic per a la verificació pendent creada per un enviament anterior (gratuït). Undeliverable — l'adreça no ha superat la validació de lliurabilitat o no s'ha pogut enviar el missatge; la verificació es finalitza immediatament com a Declined i no es factura res.

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

email_can_not_be_delivered quan status és Undeliverable; null en cas contrari.

Opcions disponibles:
email_can_not_be_delivered,
null
vendor_data
string | null

Ressò de les vendor_data emmagatzemades a la sessió (des del primer enviament).

metadata
object | null

Ressò de les metadata emmagatzemades a la sessió (des del primer enviament).

Darrera modificació el 7 de novembre del 2026