Saltar para o conteúdo principal
POST
curl

Autorizações

x-api-key
string
header
obrigatório

A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está incorreta, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. Consulte https://docs.didit.me/console/api-keys.

Corpo

application/json
email
string<email>
obrigatório

Endereço de e-mail do destinatário. Endereços malformados devolvem 400; endereços sintaticamente válidos que não conseguem receber correio (falha na validação de DNS/MX) devolvem 200 com status: "Undeliverable".

Exemplo:

"alice@example.com"

options
object

Opções de formato, localização e personalização de marca do OTP. Todos os campos são opcionais.

signals
object

Sinais opcionais de dispositivo e rede sobre o utilizador final, encaminhados para a camada antifraude para melhorar a deteção de tráfego abusivo ou automatizado. Todos os campos são opcionais.

vendor_data
string

Identificador opcional controlado pelo chamador (o seu ID de utilizador interno, um e-mail, um UUID, etc.) guardado na sessão e devolvido na resposta de envio, na resposta de verificação de correspondência, nos webhooks e na Business Console. Utilize-o para correlacionar o request_id da Didit com o registo do seu utilizador.

metadata
object | null

Objeto JSON de formato livre opcional persistido na sessão e devolvido na resposta de envio, na resposta de verificação de correspondência, nos webhooks e na Business Console.

Resposta

Envio confirmado. Inspecione status: Success e Retry significam que um código está a caminho; Undeliverable significa que a morada não pode receber correio e a verificação já foi finalizada como Declined. request_id é o ID persistido da sessão (o mesmo ID num Retry).

request_id
string<uuid>

ID de sessão da verificação. Um envio de Retry devolve o mesmo request_id que o envio original. Este id surge na Business Console, é devolvido novamente por um POST /v3/email/check/ finalizado e pode ser passado para GET /v3/session/{sessionId}/decision/.

status
enum<string>

Success — OTP enviado por e-mail para uma nova verificação (faturado). Retry — novo OTP enviado por e-mail para a verificação pendente criada por um envio anterior (gratuito). Undeliverable — o endereço falhou a validação de capacidade de entrega ou a mensagem não pôde ser enviada; a verificação é imediatamente finalizada como Declined e nada é faturado.

Opções disponíveis:
Success,
Retry,
Undeliverable
reason
enum<string> | null

email_can_not_be_delivered quando status é Undeliverable; null caso contrário.

Opções disponíveis:
email_can_not_be_delivered,
null
vendor_data
string | null

Eco do objeto vendor_data armazenado na sessão (do primeiro envio).

metadata
object | null

Eco do objeto metadata armazenado na sessão (do primeiro envio).

Última modificação em 7 de novembro de 2026