Pular para o conteúdo principal
POST
curl

Autorizações

x-api-key
string
header
obrigatório

Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, 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á errada, 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 a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. 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 retornam 400; endereços sintaticamente válidos que não podem receber e-mails (falha na validação de DNS/MX) retornam 200 com status: "Undeliverable".

Exemplo:

"alice@example.com"

options
object

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

signals
object

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

vendor_data
string

Identificador opcional controlado por quem faz a chamada (seu id interno de usuário, um e-mail, um UUID etc.), persistido na sessão e devolvido na resposta do envio, na resposta da verificação correspondente, nos webhooks e no Business Console. Use-o para correlacionar o request_id da Didit com o registro do seu usuário.

metadata
object | null

Objeto JSON livre e opcional, persistido na sessão e devolvido na resposta de envio, na resposta da verificação correspondente, nos webhooks e no Business Console.

Resposta

Envio confirmado. Verifique status: Success e Retry significam que um código está a caminho; Undeliverable significa que o endereço não pode receber e-mails e a verificação já foi finalizada como Declined. request_id é o id da sessão persistida (o mesmo id em um Retry).

request_id
string<uuid>

ID da sessão da verificação. Um envio Retry retorna o mesmo request_id do envio original. Este ID aparece no Business Console, é retornado 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 (cobrado). Retry: novo OTP enviado por e-mail para a verificação pendente criada por um envio anterior (gratuito). Undeliverable: o endereço não passou na validação de entregabilidade ou não foi possível enviar a mensagem; a verificação é finalizada imediatamente como Declined e nada é cobrado.

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

email_can_not_be_delivered quando status é Undeliverable; null nos demais casos.

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

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

metadata
object | null

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

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