Vérification de l'e-mail : API de contrôle du code OTP

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

Module complémentaire Intelligence

Définissez enable_enrichment sur true pour effectuer également une analyse de l’adresse e-mail : un score de risque et son historique de fuites de données. Ce module complémentaire est facturé $0.05 par requête au tarif public, en plus du prix de la vérification. La requête renvoie 403 lorsque votre solde ne couvre pas ce montant. Trois champs déterminent l’effet des signaux. Chacun vaut NO_ACTION (valeur par défaut) ou DECLINE, et chacun ne prend effet que lorsque enable_enrichment vaut true.

Champ	Refuse lorsque
`email_intelligence_score_action`	Le score de risque est supérieur au seuil.
`recent_email_breach_action`	L’adresse figure dans une violation de données connue et récente.
`frequent_email_breach_action`	L’adresse figure dans de nombreuses violations de données connues.

Avec NO_ACTION, le signal est tout de même renvoyé dans email.email_intelligence, ce qui vous permet d’appliquer votre propre règle.

Autorisations

x-api-key

string

header

requis

La clé API de votre application, issue de Développeurs -> Clés API dans la Business Console. La clé principale dispose d'un accès complet. Une clé nommée peut être restreinte : aucun, lecture ou écriture par ressource, limitée à certains workflows ou aux sessions approuvées, à une liste d'adresses IP et à une date d'expiration. 401 signifie que la clé est incorrecte, révoquée ou expirée ; 403 signifie qu'aucune clé n'a été envoyée, que la clé n'a pas accès à cette ressource ou action, ou que la requête provient d'une adresse hors de sa liste d'IP ; 404 sur une route de session signifie que la session est hors des workflows ou des statuts de la clé. Une clé sans accès aux médias reçoit les URL d'images, de vidéos et de PDF à null, et une clé sans accès en écriture aux sessions reçoit les liens et tokens de session à null. Voir https://docs.didit.me/console/api-keys.

Corps

application/json

string<email>

requis

La même adresse e-mail que celle utilisée dans l'appel POST /v3/email/send/ correspondant. C'est ce qui associe la vérification à l'envoi.

Exemple:

"alice@example.com"

code

string

requis

L'OTP reçu par l'utilisateur final : 4 à 8 chiffres, ou 4 à 8 lettres/chiffres lorsque alphanumeric_code: true a été utilisé lors de l'envoi. La comparaison est insensible à la casse.

Maximum string length: 10

Exemple:

"123456"

duplicated_email_action

enum<string>

défaut:NO_ACTION

Que faire lorsque la même adresse a déjà été utilisée et approuvée par un utilisateur différent (seules les vérifications précédemment approuvées comptent) (vendor_data distinct) de votre application. DECLINE fait passer le status final à Declined ; NO_ACTION enregistre le risque dans email.warnings et renseigne email.matches.

Options disponibles:

NO_ACTION,

DECLINE

breached_email_action

enum<string>

défaut:NO_ACTION

Ce qu'il faut faire lorsque l'adresse apparaît dans des violations de données connues (email.is_breached). DECLINE fait passer le status final à Declined ; NO_ACTION enregistre le risque dans email.warnings.

Options disponibles:

NO_ACTION,

DECLINE

disposable_email_action

enum<string>

défaut:NO_ACTION

Que faire lorsque le domaine appartient à un fournisseur d'adresses e-mail jetables/temporaires (email.is_disposable). DECLINE fait passer le status final à Declined ; NO_ACTION enregistre le risque dans email.warnings.

Options disponibles:

NO_ACTION,

DECLINE

enable_enrichment

boolean

défaut:false

Lorsque la valeur est true, exécute également une analyse de renseignements sur l'adresse e-mail : un score de risque et son historique de fuites de données. Facturé comme une unité email_intelligence_api par requête ($0.05 au prix catalogue) en plus du prix propre à cet endpoint. La requête renvoie 403 lorsque votre solde ne permet pas de la couvrir.

Exemple:

false

email_intelligence_score_action

enum<string>

défaut:NO_ACTION

Action lorsque le score de risque de l'intelligence e-mail est supérieur au seuil. DECLINE fait passer le status final à Declined ; NO_ACTION enregistre le signal sans refuser. Ne prend effet que lorsque enable_enrichment est true.

Options disponibles:

NO_ACTION,

DECLINE

recent_email_breach_action

enum<string>

défaut:NO_ACTION

Action lorsque l'adresse apparaît dans une fuite de données connue récente. DECLINE bascule le status final à Declined ; NO_ACTION enregistre le signal sans refuser. Ne prend effet que lorsque enable_enrichment est true.

Options disponibles:

NO_ACTION,

DECLINE

frequent_email_breach_action

enum<string>

défaut:NO_ACTION

Action lorsque l'adresse apparaît dans de nombreuses fuites de données connues. DECLINE bascule le status final à Declined ; NO_ACTION enregistre le signal sans refuser. Ne prend effet que lorsque enable_enrichment est true.

Options disponibles:

NO_ACTION,

DECLINE

Si true, recherche également l'empreinte sociale de l'adresse : les plateformes d'e-mail, sociales, professionnelles, d'e-commerce et de divertissement sur lesquelles elle est enregistrée. Facturé comme une unité email_social par requête en plus du prix propre à cet endpoint.

Exemple:

true

Action lorsque la vérification de l'empreinte sociale ne trouve l'adresse enregistrée sur aucune des plateformes couvertes. Seuls NO_ACTION et DECLINE sont acceptés sur cet endpoint ; REVIEW est disponible sur la clé de configuration du workflow du même nom.

Options disponibles:

NO_ACTION,

DECLINE

Réponse

Vérification terminée — les codes erronés et les vérifications manquantes renvoient également 200 ; inspectez status, et non le code HTTP. email n'est renseigné que pour les résultats finalisés (Approved/Declined), vaut null pour Failed, et est absent pour Expired or Not Found.

request_id

string<uuid>

Pour Approved/Declined : l'identifiant de session de la vérification correspondante — identique au request_id renvoyé par POST /v3/email/send/. Pour Failed et Expired or Not Found : un UUID aléatoire à usage unique qui ne pourra pas être consulté ultérieurement.

status

enum<string>

Approved — code correct, aucun risque de refus. Declined — définitif : un risque entraînant un refus a correspondu ou le nombre maximal de tentatives (3) a été épuisé. Failed — code erroné, tentatives restantes. Expired or Not Found — aucune vérification en attente pour cette adresse au cours des 5 dernières minutes.

Options disponibles:

Approved,

Declined,

Failed,

Expired or Not Found

message

string

Explication lisible par l'humain du résultat, incluant le nombre de tentatives restantes après un code erroné.

object | null

Rapport d'e-mail complet. Présent (non null) uniquement pour les résultats finalisés (Approved/Declined) ; null pour Failed et absent pour Expired or Not Found.

Show child attributes

vendor_data

string | null

vendor_data de la session de la vérification correspondante. null pour Expired or Not Found.

metadata

object | null

metadata de la session de la vérification correspondante. null pour Expired or Not Found.

created_at

string<date-time>

Horodatage de cette réponse de vérification.

Dernière modification le 7 novembre 2026

​Module complémentaire Intelligence

Autorisations

Corps

Réponse

Module complémentaire Intelligence