API de risco de e-mail: entregabilidade e vazamentos

curl

curl -X POST https://verification.didit.me/v3/email/risk/ \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "alice@example.com",
    "country_code": "US",
    "vendor_data": "lead-123",
    "metadata": {"source": "signup_prescreen"}
  }'

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

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

import me.didit.Didit;
import me.didit.types.EmailRiskRequest;

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

var result = client.email().assessRisk(EmailRiskRequest.builder()
        .email("alice@example.com")
        .build());
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

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

$result = $didit->email->assessRisk([
    'email' => 'alice@example.com',
]);
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.AssessRiskAsync(new EmailRiskRequest
{
    Email = "alice@example.com",
});
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "request_id": "82397be9-5921-4970-a979-2d5b43e08b33",
  "status": "Approved",
  "email": {
    "status": "Approved",
    "email": "alice@example.com",
    "is_breached": false,
    "breaches": [],
    "is_disposable": false,
    "is_undeliverable": false,
    "verification_attempts": 0,
    "verified_at": null,
    "warnings": [],
    "lifecycle": [],
    "matches": [],
    "email_intelligence": {
      "score": 4,
      "deliverable": "high",
      "breach_risk_level": "Low",
      "breach_risk_index": 4,
      "is_recent_breach": false,
      "is_frequent_breached": false,
      "is_disposable": false,
      "is_free_domain": false,
      "is_breached": false,
      "no_of_breaches": 0,
      "reason_codes": []
    },
    "enrichment": {
      "score": 4,
      "deliverable": "high",
      "breach_risk_level": "Low",
      "breach_risk_index": 4,
      "is_recent_breach": false,
      "is_frequent_breached": false,
      "is_disposable": false,
      "is_free_domain": false,
      "is_breached": false,
      "no_of_breaches": 0,
      "reason_codes": []
    }
  },
  "vendor_data": "lead-123",
  "metadata": {
    "source": "signup_prescreen"
  },
  "created_at": "2026-09-01T10:30:00.123456+00:00"
}

POST

risk

curl

curl -X POST https://verification.didit.me/v3/email/risk/ \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "alice@example.com",
    "country_code": "US",
    "vendor_data": "lead-123",
    "metadata": {"source": "signup_prescreen"}
  }'

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

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

import me.didit.Didit;
import me.didit.types.EmailRiskRequest;

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

var result = client.email().assessRisk(EmailRiskRequest.builder()
        .email("alice@example.com")
        .build());
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

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

$result = $didit->email->assessRisk([
    'email' => 'alice@example.com',
]);
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.AssessRiskAsync(new EmailRiskRequest
{
    Email = "alice@example.com",
});
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "request_id": "82397be9-5921-4970-a979-2d5b43e08b33",
  "status": "Approved",
  "email": {
    "status": "Approved",
    "email": "alice@example.com",
    "is_breached": false,
    "breaches": [],
    "is_disposable": false,
    "is_undeliverable": false,
    "verification_attempts": 0,
    "verified_at": null,
    "warnings": [],
    "lifecycle": [],
    "matches": [],
    "email_intelligence": {
      "score": 4,
      "deliverable": "high",
      "breach_risk_level": "Low",
      "breach_risk_index": 4,
      "is_recent_breach": false,
      "is_frequent_breached": false,
      "is_disposable": false,
      "is_free_domain": false,
      "is_breached": false,
      "no_of_breaches": 0,
      "reason_codes": []
    },
    "enrichment": {
      "score": 4,
      "deliverable": "high",
      "breach_risk_level": "Low",
      "breach_risk_index": 4,
      "is_recent_breach": false,
      "is_frequent_breached": false,
      "is_disposable": false,
      "is_free_domain": false,
      "is_breached": false,
      "no_of_breaches": 0,
      "reason_codes": []
    }
  },
  "vendor_data": "lead-123",
  "metadata": {
    "source": "signup_prescreen"
  },
  "created_at": "2026-09-01T10:30:00.123456+00:00"
}

Use POST /v3/email/risk/ quando você precisar de inteligência de e-mail sem pedir ao usuário que digite um código de uso único. Ele não envia e-mail. Ele cria uma sessão de API, enriquece o endereço, aplica suas regras de risco de e-mail e retorna, em uma única resposta síncrona, o mesmo bloco de e-mail normalizado usado pela Verificação de e-mail. Quando a requisição é salva, a Didit também pode usar o e-mail avaliado como evidência agregada em Networks. Os grafos de rede podem exibir inteligência de e-mail de alto risco, contexto de vazamentos e cobertura de perfis sociais em sinais de e-mail compartilhados, mas não revelam o endereço de e-mail original a outras organizações.

Interpretar a resposta

status é a decisão final desta sessão de API. Normalmente é Approved; a avaliação de risco pode produzir In Review ou Declined.
email.is_breached, email.is_disposable e email.is_undeliverable são os sinais estáveis de sim/não para a lógica da sua aplicação.
email.breaches lista os vazamentos conhecidos mais recentes que contêm o endereço, quando há cobertura, com a data do vazamento e as classes de dados expostas.
email.email_intelligence.score usa uma escala de risco de 0 a 100, em que um número maior significa risco maior. breach_risk_level (Low, Medium, High) e no_of_breaches são visões derivadas.
email.email_intelligence.reason_codes explica quais sinais normalizados contribuíram para o resultado. Os valores podem aumentar com o tempo, então não rejeite códigos desconhecidos.
email.email_intelligence e email.enrichment são aliases de compatibilidade com o mesmo objeto normalizado. Novas integrações podem ler email.enrichment.
email.matches lista outras sessões da sua aplicação em que o mesmo endereço foi usado por um usuário diferente. Use-o para detectar contas duplicadas.
request_id é o ID da sessão de API. Armazene-o com vendor_data se precisar correlacionar o resultado com webhooks posteriores ou com a atividade no console.

email.email_intelligence e email.enrichment são campos sujeitos à disponibilidade de dados. Uma consulta concluída pode omitir ambos quando nenhum dado de inteligência utilizável é retornado para aquele endereço, domínio ou plano. Construa suas regras primeiro com base em is_breached, is_disposable e is_undeliverable, e trate a ausência de inteligência como “desconhecido”, não como “seguro”.

Defina enable_social como true para adicionar um bloco email_social à resposta, dentro de email: as plataformas online em que este endereço de e-mail está cadastrado, agrupadas por categoria, com as contagens resumidas e os detalhes de perfil que nossos parceiros de dados retornarem.

email.email_social.profiles_registered e email.email_social.profiles_checked são os números principais: plataformas em que o endereço de e-mail tem cadastro confirmado, do total de plataformas avaliadas.
email.email_social.registered_platforms e email.email_social.not_registered_platforms listam cada plataforma com sua category e seu scope (global, ou local para plataformas específicas de uma região).
email.email_social.categories informa a contagem de cadastros e a proporção por categoria, e email.email_social.profiles traz os detalhes de perfil por plataforma quando a plataforma os expõe (nome, URL da foto, texto de apresentação, status de privacidade, indicador de conta comercial).
Os índices resumidos (digital_footprint_diversity, digital_sophistication_index, engagement_depth_index, subscription_affordability_index) são compostos de 0 a 10. Qualquer contagem pode ser null quando a verificação não retornou dados para ela.

profiles_registered: 0 é uma resposta real, não uma falha: as plataformas foram verificadas e o endereço de e-mail não foi encontrado em nenhuma delas, o que é um sinal comum de identidade sintética. Este endpoint não age sobre isso por conta própria: use email_no_social_presence_action em um workflow para transformá-lo em um veredito de revisão (Review) ou de recusa (Decline). O bloco fica ausente quando enable_social não está definido e também quando a verificação social não pôde ser concluída; nesse caso, ela não é cobrada.

Comportamento no sandbox

As chaves de sandbox validam a requisição e retornam dados determinísticos aprovados. Elas não enviam e-mail, não consomem créditos, não criam sessão e não contribuem para Networks. Com enable_social definido, elas também retornam um bloco email_social determinístico.

Faturamento

As chamadas à Email Risk API custam $0.04 pelo preço de tabela, menos do que custaria a Verificação de e-mail completa, porque nenhum e-mail é enviado. Uma requisição em produção passa a ser cobrada assim que a consulta começa, mesmo quando alguns campos fornecidos conforme disponibilidade não estão disponíveis. O complemento de presença em redes sociais é cobrado à parte: uma unidade email_social por requisição, além do preço da Email Risk API, sempre que a verificação é concluída. A checagem de créditos antes da consulta cobre os dois.

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

string<email>

obrigatório

Endereço de e-mail a ser pontuado.

Exemplo:

"alice@example.com"

country_code

string

Indicação opcional de país em ISO 3166-1 alfa-2 ou alfa-3 para a cobertura de inteligência.

Maximum string length: 3

Exemplo:

"US"

signals

object

Contexto opcional de dispositivo e rede observado pela sua aplicação. Todos os campos são opcionais. Enviá-los alimenta a detecção de correspondências entre sessões em Networks.

Show child attributes

vendor_data

string

Sua referência estável para esta requisição. Armazenada na sessão da API e devolvida na resposta.

metadata

object | null

Seus metadados JSON não sensíveis. Armazenados na sessão da API e retornados na resposta.

Quando verdadeiro, também consulta a presença digital do endereço: as plataformas de e-mail, redes sociais, profissionais, e-commerce e entretenimento em que ele está cadastrado. Cobrado como uma unidade email_social por requisição, além do preço deste endpoint.

Exemplo:

true

Resposta

A avaliação de risco foi concluída. Verifique status para ver a decisão; o HTTP é sempre 200 para consultas concluídas.

request_id

string<uuid>

obrigatório

Id da sessão de API criada para esta requisição. Armazene-o com vendor_data se precisar correlacionar o resultado com webhooks posteriores ou com a atividade no console.

status

enum<string>

obrigatório

Decisão final desta sessão de API. Normalmente Approved; a avaliação de risco pode resultar em In Review ou Declined.

Opções disponíveis:

Approved,

In Review,

Declined

created_at

string<date-time>

obrigatório

Data e hora desta resposta.

vendor_data

string | null

Eco do vendor_data que você enviou, null quando você não enviou nenhum.

metadata

object | null

Eco do metadata que você enviou, null quando você não enviou nenhum.

object

Relatório de e-mail normalizado, o mesmo bloco usado nas respostas de Verificação de e-mail.

Show child attributes

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

​Interpretar a resposta

​Complemento de pegada social

​Comportamento no sandbox

​Faturamento

Autorizações

Corpo

Resposta

Interpretar a resposta

Complemento de pegada social

Comportamento no sandbox

Faturamento