API de validação de código OTP por e-mail

curl

curl -X POST https://verification.didit.me/v3/email/check/ \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "alice@example.com",
    "code": "123456",
    "disposable_email_action": "DECLINE"
  }'

import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.email.checkCode({
  email: "alice@example.com",
  code: "123456",
});
console.log(result);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.Email.CheckCode(ctx, didit.EmailCheckCodeParams{
	Email: "alice@example.com",
	Code:  "123456",
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

import me.didit.Didit;
import me.didit.types.EmailCheckCodeParams;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.email().checkCode(EmailCheckCodeParams.builder()
        .email("alice@example.com")
        .code("123456")
        .build());
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->email->checkCode([
    'email' => 'alice@example.com',
    'code' => '123456',
]);
print_r($result->toArray());

using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.Email.CheckCodeAsync(new EmailCheckCodeParams
{
    Email = "alice@example.com",
    Code = "123456",
});
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "request_id": "e39cb057-92fc-4b59-b84e-02fec29a0f24",
  "status": "Approved",
  "message": "The verification code is correct.",
  "email": {
    "status": "Approved",
    "email": "alice@example.com",
    "is_breached": false,
    "breaches": [],
    "is_disposable": false,
    "is_undeliverable": false,
    "verification_attempts": 1,
    "verified_at": "2026-06-12T01:24:47.311323Z",
    "warnings": [],
    "lifecycle": [
      {
        "type": "EMAIL_VERIFICATION_MESSAGE_SENT",
        "timestamp": "2026-06-12T01:23:39.580554+00:00",
        "details": {
          "status": "Success",
          "reason": null
        },
        "fee": 0.02
      },
      {
        "type": "VALID_CODE_ENTERED",
        "timestamp": "2026-06-12T01:24:47.311201+00:00",
        "details": {
          "code_tried": "123456",
          "status": "Approved"
        },
        "fee": 0
      },
      {
        "type": "EMAIL_VERIFICATION_APPROVED",
        "timestamp": "2026-06-12T01:24:47.384292+00:00",
        "details": null,
        "fee": 0
      }
    ],
    "matches": []
  },
  "vendor_data": "user-1234",
  "metadata": null,
  "created_at": "2026-06-12T01:24:47.401719+00:00"
}

POST

check

curl

curl -X POST https://verification.didit.me/v3/email/check/ \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "alice@example.com",
    "code": "123456",
    "disposable_email_action": "DECLINE"
  }'

import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.email.checkCode({
  email: "alice@example.com",
  code: "123456",
});
console.log(result);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.Email.CheckCode(ctx, didit.EmailCheckCodeParams{
	Email: "alice@example.com",
	Code:  "123456",
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

import me.didit.Didit;
import me.didit.types.EmailCheckCodeParams;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.email().checkCode(EmailCheckCodeParams.builder()
        .email("alice@example.com")
        .code("123456")
        .build());
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->email->checkCode([
    'email' => 'alice@example.com',
    'code' => '123456',
]);
print_r($result->toArray());

using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.Email.CheckCodeAsync(new EmailCheckCodeParams
{
    Email = "alice@example.com",
    Code = "123456",
});
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "request_id": "e39cb057-92fc-4b59-b84e-02fec29a0f24",
  "status": "Approved",
  "message": "The verification code is correct.",
  "email": {
    "status": "Approved",
    "email": "alice@example.com",
    "is_breached": false,
    "breaches": [],
    "is_disposable": false,
    "is_undeliverable": false,
    "verification_attempts": 1,
    "verified_at": "2026-06-12T01:24:47.311323Z",
    "warnings": [],
    "lifecycle": [
      {
        "type": "EMAIL_VERIFICATION_MESSAGE_SENT",
        "timestamp": "2026-06-12T01:23:39.580554+00:00",
        "details": {
          "status": "Success",
          "reason": null
        },
        "fee": 0.02
      },
      {
        "type": "VALID_CODE_ENTERED",
        "timestamp": "2026-06-12T01:24:47.311201+00:00",
        "details": {
          "code_tried": "123456",
          "status": "Approved"
        },
        "fee": 0
      },
      {
        "type": "EMAIL_VERIFICATION_APPROVED",
        "timestamp": "2026-06-12T01:24:47.384292+00:00",
        "details": null,
        "fee": 0
      }
    ],
    "matches": []
  },
  "vendor_data": "user-1234",
  "metadata": null,
  "created_at": "2026-06-12T01:24:47.401719+00:00"
}

Complemento de inteligência

Defina enable_enrichment como true para também executar a inteligência de e-mail sobre o endereço: uma pontuação de risco e o respetivo histórico de violações de dados. O complemento é faturado a $0.05 por pedido, ao preço de tabela, além do preço da verificação. O pedido devolve 403 quando o seu saldo não cobre este valor. Três campos determinam o efeito dos sinais. Cada um pode ter o valor NO_ACTION (predefinição) ou DECLINE, e cada um só tem efeito quando enable_enrichment é true.

Campo	Recusa quando
`email_intelligence_score_action`	A pontuação de risco está acima do limiar.
`recent_email_breach_action`	O endereço aparece numa violação de dados conhecida e recente.
`frequent_email_breach_action`	O endereço aparece em muitas violações de dados conhecidas.

Com NO_ACTION, o sinal continua a ser devolvido em email.email_intelligence, para que possa aplicar a sua própria regra.

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

string<email>

obrigatório

O mesmo endereço de e-mail utilizado na chamada POST /v3/email/send/ correspondente. É isto que associa a verificação ao envio.

Exemplo:

"alice@example.com"

code

string

obrigatório

O OTP que o utilizador final recebeu: 4–8 dígitos, ou 4–8 letras/dígitos quando alphanumeric_code: true foi utilizado no momento do envio. A comparação não diferencia maiúsculas de minúsculas.

Maximum string length: 10

Exemplo:

"123456"

duplicated_email_action

enum<string>

padrão:NO_ACTION

O que fazer quando o mesmo endereço já foi utilizado e aprovado por um utilizador diferente (apenas contam verificações aprovadas anteriormente) (com um vendor_data diferente) da sua aplicação. DECLINE altera o status final para Declined; NO_ACTION regista o risco em email.warnings e preenche email.matches.

Opções disponíveis:

NO_ACTION,

DECLINE

breached_email_action

enum<string>

padrão:NO_ACTION

O que fazer quando o endereço constar de fugas de dados conhecidas (email.is_breached). DECLINE altera o status final para Declined; NO_ACTION regista o risco em email.warnings.

Opções disponíveis:

NO_ACTION,

DECLINE

disposable_email_action

enum<string>

padrão:NO_ACTION

O que fazer quando o domínio pertence a um fornecedor de e-mail temporário/descartável (email.is_disposable). DECLINE altera o status final para Declined; NO_ACTION regista o risco em email.warnings.

Opções disponíveis:

NO_ACTION,

DECLINE

enable_enrichment

boolean

padrão:false

Quando true, executa também inteligência de e-mail sobre o endereço: uma pontuação de risco e o respetivo histórico de violações de dados. Faturado como uma unidade email_intelligence_api por pedido ($0.05 ao preço de tabela), além do próprio preço deste endpoint. O pedido devolve 403 quando o seu saldo não for suficiente para cobri-lo.

Exemplo:

false

email_intelligence_score_action

enum<string>

padrão:NO_ACTION

Ação quando a pontuação de risco da inteligência de e-mail está acima do limiar. DECLINE altera o status final para Declined; NO_ACTION regista o sinal sem recusar. Apenas tem efeito quando enable_enrichment é true.

Opções disponíveis:

NO_ACTION,

DECLINE

recent_email_breach_action

enum<string>

padrão:NO_ACTION

Ação quando o endereço surge numa violação de dados conhecida recente. DECLINE altera o status final para Declined; NO_ACTION regista o sinal sem recusar. Só produz efeitos quando enable_enrichment for true.

Opções disponíveis:

NO_ACTION,

DECLINE

frequent_email_breach_action

enum<string>

padrão:NO_ACTION

Ação quando o endereço surge em muitas violações de dados conhecidas. DECLINE altera o status final para Declined; NO_ACTION regista o sinal sem recusar. Só produz efeitos quando enable_enrichment for true.

Opções disponíveis:

NO_ACTION,

DECLINE

Quando for true, consulta também a pegada social do endereço: as plataformas de e-mail, redes sociais, profissionais, de comércio eletrónico e de entretenimento nas quais está registado. Faturado como uma unidade email_social por pedido, além do preço do próprio endpoint.

Exemplo:

true

Ação quando a verificação da pegada social deteta que o endereço não está registado em nenhuma das plataformas abrangidas. Apenas NO_ACTION e DECLINE são aceites neste endpoint; REVIEW está disponível na chave de configuração do fluxo com o mesmo nome.

Opções disponíveis:

NO_ACTION,

DECLINE

Resposta

Verificação concluída — códigos errados e verificações em falta também devolvem 200; inspecione status, não o código HTTP. email é preenchido apenas em resultados finalizados (Approved/Declined), null em Failed e ausente em Expired or Not Found.

request_id

string<uuid>

Em Approved/Declined: o id da sessão da verificação correspondente — idêntico ao request_id devolvido por POST /v3/email/send/. Em Failed e Expired or Not Found: um UUID pontual aleatório que não pode ser consultado mais tarde.

status

enum<string>

Approved — código correto, sem risco de recusa. Declined — terminal: um risco de recusa correspondeu ou o limite de tentativas (3) esgotou-se. Failed — código incorreto, tentativas restantes. Expired or Not Found — nenhuma verificação pendente para este endereço nos últimos 5 minutos.

Opções disponíveis:

Approved,

Declined,

Failed,

Expired or Not Found

message

string

Explicação legível do resultado, incluindo o número de tentativas restantes após um código incorreto.

object | null

Relatório completo de e-mail. Presente (não nulo) apenas em resultados finalizados (Approved/Declined); null em Failed e ausente em Expired or Not Found.

Show child attributes

vendor_data

string | null

vendor_data da sessão da verificação correspondente. null em Expired or Not Found.

metadata

object | null

metadata da sessão da verificação correspondente. null em Expired or Not Found.

created_at

string<date-time>

Carimbo de data/hora desta resposta de verificação.

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

​Complemento de inteligência

Autorizações

Corpo

Resposta

Complemento de inteligência