API de risc de correu: lliurabilitat i filtracions

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"
}

Utilitza POST /v3/email/risk/ quan necessitis informació de risc de correu electrònic sense demanar a l’usuari que introdueixi un codi d’un sol ús. No envia cap correu electrònic. Crea una sessió de l’API, enriqueix l’adreça, aplica les teves regles de risc per a correus electrònics i retorna en una sola resposta síncrona el mateix bloc de correu electrònic normalitzat que utilitza la Verificació de correu electrònic. Quan la sol·licitud es desa, Didit també pot utilitzar el correu electrònic puntuat com a evidència agregada a Xarxes. Els grafs de xarxes poden mostrar informació d’alt risc sobre correus electrònics, context de filtracions i cobertura de perfils socials en senyals de correu electrònic compartits, però no revelen l’adreça de correu electrònic en brut a altres organitzacions.

Interpreta la resposta

status és la decisió final per a aquesta sessió de l’API. Normalment és Approved; l’avaluació de risc pot produir In Review o Declined.
email.is_breached, email.is_disposable i email.is_undeliverable són els senyals estables de tipus sí/no per a la lògica de l’aplicació.
email.breaches enumera les filtracions conegudes més recents que contenen l’adreça, quan hi ha cobertura disponible, amb la data de la filtració i les classes de dades exposades.
email.email_intelligence.score utilitza una escala de risc de 0 a 100, on un número més alt indica un risc més alt. breach_risk_level (Low, Medium, High) i no_of_breaches són vistes derivades.
email.email_intelligence.reason_codes explica quins senyals normalitzats han contribuït al resultat. Els valors poden créixer amb el temps, així que no rebutgis els codis desconeguts.
email.email_intelligence i email.enrichment són àlies de compatibilitat amb el mateix objecte normalitzat. Les integracions noves poden llegir email.enrichment.
email.matches enumera altres sessions de la teva aplicació en què la mateixa adreça ha estat utilitzada per un usuari diferent. Utilitza-ho per a la detecció de comptes duplicats.
request_id és l’identificador de la sessió de l’API. Desa’l amb vendor_data si necessites correlacionar el resultat amb webhooks posteriors o amb l’activitat de la consola.

email.email_intelligence i email.enrichment són camps de millor esforç. Una consulta completada pot no incloure’n cap dels dos quan no es retornen dades d’intel·ligència utilitzables per a aquella adreça, aquell domini o aquell pla. Construeix primer les regles sobre is_breached, is_disposable i is_undeliverable, i tracta la intel·ligència que falti com a “desconeguda”, no com a “segura”.

Estableix enable_social a true per afegir un bloc email_social a la resposta, sota email: les plataformes en línia on està registrada aquesta adreça de correu electrònic, agrupades per categoria, amb els recomptes de resum i els detalls de perfil que retornin els nostres socis de dades.

email.email_social.profiles_registered i email.email_social.profiles_checked són les xifres principals: les plataformes on es confirma que l’adreça de correu electrònic està registrada, sobre el total de plataformes avaluades.
email.email_social.registered_platforms i email.email_social.not_registered_platforms enumeren cada plataforma amb la seva category i el seu scope (global, o local per a plataformes específiques d’una regió).
email.email_social.categories indica el recompte de plataformes registrades i la proporció per categoria, i email.email_social.profiles conté els detalls de perfil per plataforma quan una plataforma els exposa (nom, URL de la foto, text de presentació, estat de privacitat, indicador de compte empresarial).
Els índexs de resum (digital_footprint_diversity, digital_sophistication_index, engagement_depth_index, subscription_affordability_index) són composts de 0 a 10. Qualsevol recompte pot ser null quan la comprovació no ha retornat dades per a aquest recompte.

profiles_registered: 0 és una resposta real, no un error: les plataformes s’han comprovat i l’adreça de correu electrònic no s’ha trobat en cap d’elles, cosa que és un senyal habitual d’identitat sintètica. Aquest endpoint no hi actua per si sol; utilitza email_no_social_presence_action en un flux de treball per convertir-ho en un veredicte de revisió o de rebuig. El bloc no apareix quan no s’estableix enable_social, ni tampoc quan la comprovació de xarxes socials no s’ha pogut completar; en aquest cas, no es factura.

Entorn de sandbox

Les claus de sandbox validen la sol·licitud i retornen dades aprovades deterministes. No envien cap correu electrònic, no consumeixen crèdits, no creen cap sessió ni contribueixen a Xarxes. Amb enable_social establert, també retornen un bloc email_social determinista.

Facturació

Les crides a l’API de Risc de correu electrònic costen $0.04 al preu de llista, menys del que costaria una Verificació de correu electrònic completa, perquè no s’envia cap correu electrònic. Una sol·licitud en producció es factura des del moment en què comença la consulta, fins i tot quan alguns camps de millor esforç no estiguin disponibles. El complement de petjada social es factura per separat: una unitat email_social per sol·licitud, a sobre del preu de l’API de Risc de correu electrònic, sempre que la comprovació es completi. La comprovació de crèdit prèvia a la consulta cobreix tots dos conceptes.

Autoritzacions

x-api-key

string

header

requerit

La clau d'API de la teva aplicació, des de Developers -> API keys a la Business Console. La clau primària té accés complet. Una clau amb nom pot tenir l'abast limitat: cap, lectura o escriptura per recurs, limitada a determinats fluxos de treball o a sessions aprovades, a una llista d'adreces IP i a una data de caducitat. 401 significa que la clau és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap clau, que la clau no té accés a aquest recurs o acció, o que la sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una ruta de sessió significa que la sessió està fora dels fluxos de treball o estats de la clau. Una clau sense accés a fitxers multimèdia rep els URL d'imatge, vídeo i PDF com a null, i una clau sense permís d'escriptura de sessions rep els enllaços de sessió i els tokens com a null. Consulta https://docs.didit.me/console/api-keys.

Cos

application/json

string<email>

requerit

Adreça de correu electrònic a puntuar.

Exemple:

"alice@example.com"

country_code

string

Indicació opcional de país ISO 3166-1 alfa-2 o alfa-3 per a la cobertura d'intel·ligència.

Maximum string length: 3

Exemple:

"US"

signals

object

Context opcional de dispositiu i xarxa observat per la teva aplicació. Tots els camps són opcionals. Enviar-los alimenta la detecció de coincidències entre sessions a Networks.

Show child attributes

vendor_data

string

La teva referència estable per a aquesta sol·licitud. S'emmagatzema a la sessió de l'API i es retorna a la resposta.

metadata

object | null

Les teves metadades JSON no sensibles. S'emmagatzemen a la sessió de l'API i es retornen a la resposta.

Quan és cert, també consulta la petjada social de l'adreça: les plataformes de correu electrònic, socials, professionals, de comerç electrònic i d'entreteniment on està registrada. Es factura com una unitat de email_social per sol·licitud a més del preu propi d'aquest endpoint.

Exemple:

true

Resposta

S'ha completat l'avaluació de risc. Inspecciona status per conèixer la decisió; la resposta HTTP sempre és 200 per a consultes completades.

request_id

string<uuid>

requerit

Identificador de la sessió d'API creada per a aquesta sol·licitud. Emmagatzema'l amb vendor_data si necessites correlacionar el resultat amb webhooks posteriors o amb l'activitat a la consola.

status

enum<string>

requerit

Decisió final per a aquesta sessió d'API. Normalment Approved; l'avaluació de risc pot generar In Review o Declined.

Opcions disponibles:

Approved,

In Review,

Declined

created_at

string<date-time>

requerit

Marca de temps d'aquesta resposta.

vendor_data

string | null

Ressò de les vendor_data que has enviat, null si no n'has enviat cap.

metadata

object | null

Ressò de les metadata que has enviat, null si no n'has enviat cap.

object

Informe normalitzat de correu electrònic, el mateix bloc que s'utilitza a les respostes de Verificació de correu electrònic.

Show child attributes

Darrera modificació el 7 de novembre del 2026

​Interpreta la resposta

​Complement de petjada social

​Entorn de sandbox

​Facturació

Autoritzacions

Cos

Resposta

Interpreta la resposta

Complement de petjada social

Entorn de sandbox

Facturació