E-Mail-Code prüfen: API zur Validierung von E-Mail-OTPs

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

Intelligence-Add-on

Setzen Sie enable_enrichment auf true, um zusätzlich eine E-Mail-Intelligence-Analyse für die Adresse durchzuführen: einen Risiko-Score und ihre Historie von Datenlecks. Das Add-on wird zum Listenpreis von $0.05 pro Anfrage berechnet, zusätzlich zum Preis der Prüfung. Die Anfrage gibt 403 zurück, wenn Ihr Guthaben nicht ausreicht. Drei Felder bestimmen, was die Signale bewirken. Jedes ist entweder NO_ACTION (der Standard) oder DECLINE, und jedes wirkt nur, wenn enable_enrichment den Wert true hat.

Feld	Ablehnung erfolgt, wenn
`email_intelligence_score_action`	Der Risiko-Score über dem Schwellenwert liegt.
`recent_email_breach_action`	Die Adresse in einem kürzlich erfolgten, bekannten Datenleck auftaucht.
`frequent_email_breach_action`	Die Adresse in vielen bekannten Datenlecks auftaucht.

Bei NO_ACTION wird das Signal trotzdem in email.email_intelligence zurückgegeben, sodass Sie Ihre eigene Regel anwenden können.

Autorisierungen

x-api-key

string

header

erforderlich

Der API-Schlüssel Ihrer Anwendung, aus Entwickler -> API-Schlüssel in der Business Console. Der Primärschlüssel hat Vollzugriff. Ein benannter Schlüssel kann im Geltungsbereich eingeschränkt werden: keine, Lese- oder Schreibberechtigung pro Ressource, beschränkt auf bestimmte Workflows oder genehmigte Sitzungen, auf eine Liste von IP-Adressen und auf ein Ablaufdatum. 401 bedeutet, dass der Schlüssel falsch, widerrufen oder abgelaufen ist; 403 bedeutet, dass kein Schlüssel gesendet wurde, der Schlüssel keinen Zugriff auf diese Ressource oder Aktion hat oder die Anfrage von einer Adresse außerhalb seiner IP-Liste stammte; 404 bei einer Sitzungsroute bedeutet, dass die Sitzung außerhalb der Workflows oder Status des Schlüssels liegt. Ein Schlüssel ohne Medienzugriff erhält Bild-, Video- und PDF-URLs als null, und ein Schlüssel ohne Schreibberechtigung für Sitzungen erhält Sitzungslinks und Token als null. Siehe https://docs.didit.me/console/api-keys.

Body

application/json

string<email>

erforderlich

Dieselbe E-Mail-Adresse, die im zugehörigen Aufruf von POST /v3/email/send/ verwendet wurde. Dadurch wird die Prüfung mit dem Versand verknüpft.

Beispiel:

"alice@example.com"

code

string

erforderlich

Das OTP, das der Endbenutzer erhalten hat: 4–8 Ziffern oder 4–8 Buchstaben/Ziffern, wenn beim Senden alphanumeric_code: true verwendet wurde. Beim Abgleich wird die Groß-/Kleinschreibung nicht berücksichtigt.

Maximum string length: 10

Beispiel:

"123456"

duplicated_email_action

enum<string>

Standard:NO_ACTION

Was zu tun ist, wenn dieselbe Adresse bereits von einem anderen Benutzer Ihrer Anwendung verwendet und genehmigt wurde (nur zuvor genehmigte Verifizierungen zählen) (andere vendor_data). DECLINE ändert den finalen status zu Declined; NO_ACTION erfasst das Risiko in email.warnings und befüllt email.matches.

Verfügbare Optionen:

NO_ACTION,

DECLINE

breached_email_action

enum<string>

Standard:NO_ACTION

Was zu tun ist, wenn die Adresse in bekannten Datenlecks auftaucht (email.is_breached). DECLINE setzt den endgültigen status auf Declined; NO_ACTION erfasst das Risiko in email.warnings.

Verfügbare Optionen:

NO_ACTION,

DECLINE

disposable_email_action

enum<string>

Standard:NO_ACTION

Was zu tun ist, wenn die Domain zu einem Anbieter für Wegwerf-/Temporär-E-Mails gehört (email.is_disposable). DECLINE ändert den finalen status zu Declined; NO_ACTION erfasst das Risiko in email.warnings.

Verfügbare Optionen:

NO_ACTION,

DECLINE

enable_enrichment

boolean

Standard:false

Wenn true, wird zusätzlich eine E-Mail-Intelligence für die Adresse ausgeführt: ein Risiko-Score und ihre Historie von Datenpannen. Wird als eine email_intelligence_api-Einheit pro Anfrage ($0.05 zum Listenpreis) zusätzlich zum eigenen Preis dieses Endpoints abgerechnet. Die Anfrage gibt 403 zurück, wenn Ihr Guthaben dies nicht decken kann.

Beispiel:

false

email_intelligence_score_action

enum<string>

Standard:NO_ACTION

Aktion, wenn der Risiko-Score der E-Mail-Intelligence über dem Schwellenwert liegt. DECLINE ändert den endgültigen status zu Declined; NO_ACTION erfasst das Signal, ohne abzulehnen. Wird nur wirksam, wenn enable_enrichment auf true gesetzt ist.

Verfügbare Optionen:

NO_ACTION,

DECLINE

recent_email_breach_action

enum<string>

Standard:NO_ACTION

Aktion, wenn die Adresse in einer kürzlich bekannt gewordenen Datenpanne vorkommt. DECLINE ändert den endgültigen status auf Declined; NO_ACTION erfasst das Signal, ohne abzulehnen. Wird nur wirksam, wenn enable_enrichment auf true gesetzt ist.

Verfügbare Optionen:

NO_ACTION,

DECLINE

frequent_email_breach_action

enum<string>

Standard:NO_ACTION

Aktion, wenn die Adresse in vielen bekannten Datenpannen vorkommt. DECLINE ändert den endgültigen status auf Declined; NO_ACTION erfasst das Signal, ohne abzulehnen. Wird nur wirksam, wenn enable_enrichment auf true gesetzt ist.

Verfügbare Optionen:

NO_ACTION,

DECLINE

Wenn true, wird auch der digitale Fußabdruck der Adresse ermittelt – die E-Mail-, Social-, Berufs-, E-Commerce- und Unterhaltungsplattformen, auf denen sie registriert ist. Wird als eine email_social-Einheit pro Anfrage zusätzlich zum regulären Preis dieses Endpoints abgerechnet.

Beispiel:

true

Aktion, wenn die Prüfung des digitalen Fußabdrucks (Social Footprint) ergibt, dass die Adresse auf keiner der abgedeckten Plattformen registriert ist. An diesem Endpoint werden nur NO_ACTION und DECLINE akzeptiert; REVIEW ist über den gleichnamigen Workflow-Konfigurationsschlüssel verfügbar.

Verfügbare Optionen:

NO_ACTION,

DECLINE

Antwort

Prüfung abgeschlossen – falsche Codes und fehlende Verifizierungen geben ebenfalls 200 zurück; prüfen Sie status, nicht den HTTP-Code. email ist nur bei abgeschlossenen Ergebnissen (Approved/Declined) ausgefüllt, null bei Failed und fehlt bei Expired or Not Found.

request_id

string<uuid>

Bei Approved/Declined: die Sitzungs-ID der zugeordneten Verifizierung – identisch mit der von POST /v3/email/send/ zurückgegebenen request_id. Bei Failed und Expired or Not Found: eine zufällige einmalige UUID, die später nicht nachgeschlagen werden kann.

status

enum<string>

Approved — korrekter Code, kein zur Ablehnung führendes Risiko. Declined — endgültig: Ein zur Ablehnung führendes Risiko lag vor oder das Kontingent an Versuchen (3) wurde aufgebraucht. Failed — falscher Code, verbleibende Versuche vorhanden. Expired or Not Found — keine ausstehende Verifizierung für diese Adresse in den letzten 5 Minuten.

Verfügbare Optionen:

Approved,

Declined,

Failed,

Expired or Not Found

message

string

Lesbare Erklärung des Ergebnisses, einschließlich der verbleibenden Anzahl von Versuchen nach einem falschen Code.

object | null

Vollständiger E-Mail-Bericht. Nur bei finalisierten Ergebnissen (Approved/Declined) vorhanden (nicht null); null bei Failed und nicht vorhanden bei Expired or Not Found.

Show child attributes

vendor_data

string | null

vendor_data der Sitzung der übereinstimmenden Verifizierung. null bei Expired or Not Found.

metadata

object | null

metadata der Sitzung der zugeordneten Verifizierung. null bei Expired or Not Found.

created_at

string<date-time>

Zeitstempel dieser Prüfungsantwort.

Zuletzt geändert am 7. November 2026

​Intelligence-Add-on

Autorisierungen

Body

Antwort

Intelligence-Add-on