Validar codi OTP de correu: API de verificació

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

Complement d’intel·ligència

Defineix enable_enrichment com a true per executar també la intel·ligència de correu electrònic sobre l’adreça: una puntuació de risc i el seu historial de fuites de dades. El complement es factura a $0.05 per sol·licitud al preu de llista, a sobre del preu de la verificació. La sol·licitud retorna 403 quan el teu saldo no pot cobrir-lo. Tres camps determinen l’efecte dels senyals. Cadascun pot ser NO_ACTION (el valor per defecte) o DECLINE, i cadascun només té efecte quan enable_enrichment és true.

Camp	Es rebutja quan
`email_intelligence_score_action`	La puntuació de risc és superior al llindar.
`recent_email_breach_action`	L’adreça apareix en una fuita de dades recent i coneguda.
`frequent_email_breach_action`	L’adreça apareix en moltes fuites de dades conegudes.

Amb NO_ACTION, el senyal es continua retornant a email.email_intelligence, de manera que pots aplicar la teva pròpia regla.

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

La mateixa adreça de correu electrònic utilitzada a la crida corresponent POST /v3/email/send/. Això és el que enllaça la comprovació amb l'enviament.

Exemple:

"alice@example.com"

code

string

requerit

L'OTP que ha rebut l'usuari final: 4–8 dígits, o 4–8 lletres/dígits quan s'ha utilitzat alphanumeric_code: true en el moment de l'enviament. La comparació no distingeix entre majúscules i minúscules.

Maximum string length: 10

Exemple:

"123456"

duplicated_email_action

enum<string>

predeterminat:NO_ACTION

Què fer quan la mateixa adreça ja ha estat utilitzada i aprovada per un usuari diferent (només compten les verificacions prèviament aprovades) (diferent vendor_data) de la teva aplicació. DECLINE canvia el status final a Declined; NO_ACTION registra el risc a email.warnings i emplena email.matches.

Opcions disponibles:

NO_ACTION,

DECLINE

breached_email_action

enum<string>

predeterminat:NO_ACTION

Què fer quan l'adreça apareix en filtracions de dades conegudes (email.is_breached). DECLINE canvia el status final a Declined; NO_ACTION registra el risc a email.warnings.

Opcions disponibles:

NO_ACTION,

DECLINE

disposable_email_action

enum<string>

predeterminat:NO_ACTION

Què fer quan el domini pertany a un proveïdor de correu d'un sol ús o temporal (email.is_disposable). DECLINE canvia el status final a Declined; NO_ACTION registra el risc a email.warnings.

Opcions disponibles:

NO_ACTION,

DECLINE

enable_enrichment

boolean

predeterminat:false

Quan és true, també executa intel·ligència de correu electrònic a l'adreça: una puntuació de risc i el seu historial de filtracions. Es factura com una unitat de email_intelligence_api per sol·licitud ($0.05 a preu de tarifa) a més del preu propi d'aquest endpoint. La sol·licitud retorna 403 quan el teu saldo no pot cobrir-ho.

Exemple:

false

email_intelligence_score_action

enum<string>

predeterminat:NO_ACTION

Acció quan la puntuació de risc de la intel·ligència de correu electrònic supera el llindar. DECLINE canvia l'status final a Declined; NO_ACTION registra el senyal sense rebutjar. Només té efecte quan enable_enrichment és true.

Opcions disponibles:

NO_ACTION,

DECLINE

recent_email_breach_action

enum<string>

predeterminat:NO_ACTION

Acció quan l'adreça apareix en una filtració de dades coneguda i recent. DECLINE canvia el status final a Declined; NO_ACTION registra el senyal sense rebutjar. Només té efecte quan enable_enrichment és true.

Opcions disponibles:

NO_ACTION,

DECLINE

frequent_email_breach_action

enum<string>

predeterminat:NO_ACTION

Acció quan l'adreça apareix en moltes filtracions de dades conegudes. DECLINE canvia el status final a Declined; NO_ACTION registra el senyal sense rebutjar. Només té efecte quan enable_enrichment és true.

Opcions disponibles:

NO_ACTION,

DECLINE

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

Acció quan la comprovació de petjada social no troba l'adreça registrada a cap de les plataformes que cobreix. En aquest endpoint només s'accepten NO_ACTION i DECLINE; REVIEW està disponible a la clau de configuració del flux de treball amb el mateix nom.

Opcions disponibles:

NO_ACTION,

DECLINE

Resposta

Comprovació completada — els codis incorrectes i les verificacions que falten també retornen 200; inspecciona status, no el codi HTTP. email només s'emplena en resultats finalitzats (Approved/Declined), és null a Failed, i no apareix a Expired or Not Found.

request_id

string<uuid>

A Approved/Declined: l'identificador de sessió de la verificació coincident — idèntic al request_id retornat per POST /v3/email/send/. A Failed i Expired or Not Found: un UUID aleatori d'un sol ús que no es podrà consultar posteriorment.

status

enum<string>

Approved — codi correcte, sense risc que provoqui rebuig. Declined — terminal: ha coincidit un risc que provoca rebuig o s'ha esgotat el pressupost d'intents (3). Failed — codi incorrecte, queden intents. Expired or Not Found — cap verificació pendent per a aquesta adreça en els darrers 5 minuts.

Opcions disponibles:

Approved,

Declined,

Failed,

Expired or Not Found

message

string

Explicació fàcil de llegir del resultat, inclòs el nombre d'intents restants després d'un codi incorrecte.

object | null

Informe complet de correu electrònic. Present (no nul) només en resultats finalitzats (Approved/Declined); null a Failed i absent a Expired or Not Found.

Show child attributes

vendor_data

string | null

vendor_data de la sessió de la verificació coincident. null a Expired or Not Found.

metadata

object | null

metadata de la sessió de la verificació coincident. null a Expired or Not Found.

created_at

string<date-time>

Marca de temps de la resposta d'aquesta comprovació.

Darrera modificació el 7 de novembre del 2026

​Complement d’intel·ligència

Autoritzacions

Cos

Resposta

Complement d’intel·ligència