> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# API de Verificação de E-mail: OTP e Avaliação de Risco

> Valide e-mails com OTP e análise de risco na Didit. Detete contas descartáveis, comprometidas ou inválidas por $0.02, sem mínimos mensais.

A Verificação de e-mail da Didit fornece um método fiável para verificar os endereços de e-mail dos utilizadores através de códigos de utilização única (OTP) e de uma avaliação de risco avançada. Esta funcionalidade ajuda a garantir informações de contacto válidas e acessíveis, ao mesmo tempo que protege contra e-mails comprometidos e de alto risco.

Prompt de integração da verificação de e-mail
        Copiar o prompt para a área de transferência



      
      

\<pre>

\````# Goal
Integrate Didit Email Verification (OTP send + check + deliverability / breach / disposable lookup) into your app. Pick ONE mode.

\# Mode A — Session-based
Use this when the user completes verification through a hosted Didit flow.

1\. Add the EMAIL feature to the workflow (Business Console or POST /v3/workflows/). Configure risk actions: duplicated_email_action, breached_email_action, disposable_email_action.
2\. Create a session — POST /v3/session/ with { workflow_id, vendor_data, callback }. See /sessions-api/create-session.
3\. Open session.url for the user (or mount the Web/Mobile SDK).
4\. Fetch the decision — GET /v3/session/{sessionId}/decision/ or subscribe to session.status.updated.

Decision surface: `email_verifications[]` array on the decision payload.

\# Mode B — Standalone API (server-to-server, OTP pair)
Two endpoints paired by email address.

Step 1 — send the code:
\```bash
curl -X POST 'https://verification.didit.me/v3/email/send/' \
-H "x-api-key: $DIDIT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"email": "alice@example.com",
"options": { "code_size": 6, "locale": "en", "use_white_label_customization": false },
"vendor_data": "user-1234"
}'
\```
Default: 6 numeric digits and Didit-branded delivery. Set `options.alphanumeric_code: true` for letters+digits (check is case-insensitive). Set `options.use_white_label_customization: true` to use your application's configured white-label sender and branding for this standalone OTP email; the default is `false`. `options.code_size` 4–8. Codes expire in **5 minutes**; one free retry per email within the window.

Step 2 — check the code (user types it into your UI):
\```bash
curl -X POST 'https://verification.didit.me/v3/email/check/' \
-H "x-api-key: $DIDIT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"email": "alice@example.com",
"code": "123456",
"disposable_email_action": "DECLINE"
}'
\```
Each session accepts **up to 3** code-entry attempts. The check response always includes the full email metadata (breaches[], disposable flag, deliverable flag).

\# Status enum (per email_verifications[].status / email.status)
"Not Started" | "In Progress" | "Approved" | "Declined" | "Failed" | "Undeliverable" | "Expired or Not Found" | "Abandoned" | "Kyc Expired"

\# Warnings (LogWarningChoices.EMAIL)
warnings[] risk codes include:
DUPLICATED_EMAIL, BREACHED_EMAIL, DISPOSABLE_EMAIL, UNDELIVERABLE_EMAIL, INVALID_EMAIL, OTP_MAX_ATTEMPTS_REACHED, OTP_EXPIRED.
Full catalogue: /core-technology/email-verification/warnings-email-verification.

\# Failure modes to handle
\- send response status="Undeliverable" — bounce/invalid domain; no charge, surface to the user.
\- check response status="Failed" — wrong code, attempts remaining; re-prompt.
\- check response status="Declined" — third failed attempt; restart with /v3/email/send/.
\- check response status="Expired or Not Found" — outside the 5-minute window; restart.
\- BREACHED_EMAIL warning — the address appears in known breaches; route to review per policy.

\# See also
\- Canonical schema: /reference/data-models#email-verification
\- Per-feature report: /core-technology/email-verification/report-email-verification
\- Risk catalogue: /core-technology/email-verification/warnings-email-verification
\- Full integration playbook: /integration/integration-prompt````

\</pre>



      
      

Colar em

A lição da Academy sobre a leitura de um resultado de verificação aborda a verificação de e-mail aos 8:34.[Verificação de e-mail — Didit Academy](https://www.youtube.com/embed/7htTWCWsl60?start=514\&rel=0\&playsinline=1)![Diagrama do fluxo de verificação de e-mail](https://mintcdn.com/didit-0f962782/z6T2GHM4Zh-iSj-K/images/email-verification-flow.png?fit=max\&auto=format\&n=z6T2GHM4Zh-iSj-K\&q=85\&s=23d035a261faa2063d6d941290ecf752)## Como funcionaA nossa solução de Verificação de e-mail combina a verificação por OTP com sinais de inteligência, tais como a exposição a violações de dados, a entregabilidade e a reputação do fornecedor.**1. Recolha do e-mail**O sistema recolhe de forma segura:| Dados de entrada | Descrição |
| - | - |
| **Endereço de e-mail** | Se não for fornecido durante a criação da sessão, o utilizador introduz o seu endereço de e-mail. Se for fornecido durante a criação da sessão, o utilizador tem de verificar o e-mail pré-preenchido. |
| **Idioma preferencial** | Utilizado para comunicações localizadas, quando aplicável. |**2. Geração e entrega do OTP**O nosso sistema de verificação:- Gera um código de utilização única seguro e com limite de tempo
- Envia o código por e-mail para o endereço fornecido
- Aplica as melhores práticas de entregabilidade para maximizar a entrega na caixa de entrada
- Disponibiliza fluxos de reenvio com proteções para evitar abusos**3. Validação do código**O utilizador conclui a verificação ao:- Introduzir o código recebido na interface de verificação
- Submeter dentro do prazo configurado (5 minutos)
- Solicitar um novo código, se necessário (com o devido limite de pedidos)**4. Avaliação de risco**O nosso sistema realiza verificações avançadas:| Verificação | Descrição |
| - | - |
| **Exposição a violações de dados** | Procura o e-mail em bases de dados de violações de dados conhecidas e lista os serviços expostos. |
| **Deteção de fornecedores descartáveis** | Sinaliza e-mails de fornecedores temporários/descartáveis. |
| **Verificações de entregabilidade** | Deteta endereços que não podem ser entregues ou com sintaxe inválida. |
| **Sinais de reputação** | Identifica padrões de e-mail potencialmente de alto risco. |
| **Utilização duplicada** | Cruza informações com dados históricos de verificação. |**5. Entrega de resultados**Aceda aos resultados da verificação através de múltiplos canais:| Canal | Descrição |
| - | - |
| **Painel** | Atualizações no painel em tempo real. |
| **Webhooks** | Notificações por webhook. |
| **API** | Respostas da API RESTful. |
| **Relatórios** | Relatórios abrangentes com informações detalhadas da verificação. |## Funcionalidades de verificaçãoO nosso serviço de Verificação de e-mail oferece várias funcionalidades essenciais para melhorar o seu processo de verificação:#### Verificação por OTP- **Geração segura de códigos**: Códigos de utilização única aleatórios e com limite de tempo
- **Entrega de e-mail**: Entrega de e-mails fiável e localizada
- **Tempos de expiração configuráveis**: Defina tempos de validade com base nos seus requisitos de segurança
- **Opções de nova tentativa**: Permita que os utilizadores peçam novos códigos com os limites adequados#### Análise de e-mail- **Validação de sintaxe**: Garanta que o endereço de e-mail segue o formato em conformidade com as RFCs
- **Verificações de fornecedores**: Identifique fornecedores descartáveis/temporários
- **Informações de entregabilidade**: Detete endereços que não podem ser entregues
- **Inteligência sobre violações de dados**: Apresente registos de violações conhecidas com detalhes#### Avaliação de risco- **Deteção de exposição**: Identifique se o e-mail surge em violações de dados conhecidas
- **Deteção de e-mails descartáveis**: Sinalize e-mails temporários ou descartáveis
- **Monitorização de atividade**: Monitorize padrões suspeitos ao longo de várias tentativas
- **Verificação de listas de bloqueio**: Verifique em listas internas de e-mails anteriormente utilizados de forma indevida


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.