Verifikasi Email API: Validasi Kode Sekali Pakai

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

Add-on Intelijen

Setel enable_enrichment ke true untuk juga menjalankan intelijen email pada alamat tersebut: skor risiko dan riwayat pelanggaran datanya. Add-on ini ditagih $0.05 per permintaan dengan harga daftar, di luar harga pemeriksaan itu sendiri. Permintaan akan mengembalikan 403 jika saldo Anda tidak cukup untuk menutupinya. Tiga kolom menentukan apa yang dilakukan sinyal-sinyal tersebut. Masing-masing bernilai NO_ACTION (default) atau DECLINE, dan masing-masing hanya berlaku jika enable_enrichment bernilai true.

Kolom	Ditolak jika
`email_intelligence_score_action`	Skor risiko berada di atas ambang batas.
`recent_email_breach_action`	Alamat muncul dalam pelanggaran data yang diketahui baru-baru ini.
`frequent_email_breach_action`	Alamat muncul dalam banyak pelanggaran data yang diketahui.

Dengan NO_ACTION, sinyal tetap dikembalikan dalam email.email_intelligence, sehingga Anda dapat menerapkan aturan Anda sendiri.

Otorisasi

x-api-key

string

header

wajib

Kunci API aplikasi Anda, dari Developers -> API keys di Business Console. Kunci utama memiliki akses penuh. Kunci bernama dapat diberi cakupan: none, read, atau write per sumber daya, dibatasi pada beberapa alur kerja atau pada sesi yang disetujui, pada daftar alamat IP, dan pada tanggal kedaluwarsa. 401 berarti kuncinya salah, dicabut, atau kedaluwarsa; 403 berarti tidak ada kunci yang dikirimkan, kunci tidak memiliki akses ke sumber daya atau tindakan ini, atau permintaan datang dari alamat di luar daftar IP-nya; 404 pada rute sesi berarti sesi berada di luar alur kerja atau status kunci tersebut. Kunci tanpa akses media menerima URL gambar, video, dan PDF sebagai null, dan kunci tanpa izin tulis sesi menerima tautan sesi dan token sebagai null. Lihat https://docs.didit.me/console/api-keys.

Body

application/json

string<email>

wajib

Alamat email yang sama dengan yang digunakan dalam panggilan POST /v3/email/send/ yang cocok. Ini yang menautkan pemeriksaan ke pengiriman.

Contoh:

"alice@example.com"

code

string

wajib

OTP yang diterima pengguna akhir: 4–8 digit, atau 4–8 huruf/angka jika alphanumeric_code: true digunakan saat pengiriman. Perbandingan tidak peka huruf besar/kecil.

Maximum string length: 10

Contoh:

"123456"

duplicated_email_action

enum<string>

default:NO_ACTION

Tindakan yang harus diambil ketika alamat yang sama telah digunakan dan disetujui oleh pengguna yang berbeda (hanya verifikasi yang disetujui sebelumnya yang dihitung) (vendor_data berbeda) dari aplikasi Anda. DECLINE mengubah status akhir menjadi Declined; NO_ACTION mencatat risiko dalam email.warnings dan mengisi email.matches.

Opsi yang tersedia:

NO_ACTION,

DECLINE

breached_email_action

enum<string>

default:NO_ACTION

Tindakan yang diambil saat alamat muncul dalam kebocoran data yang diketahui (email.is_breached). DECLINE mengubah status akhir menjadi Declined; NO_ACTION mencatat risiko tersebut dalam email.warnings.

Opsi yang tersedia:

NO_ACTION,

DECLINE

disposable_email_action

enum<string>

default:NO_ACTION

Tindakan yang harus diambil ketika domain milik penyedia email sekali pakai/sementara (email.is_disposable). DECLINE mengubah status akhir menjadi Declined; NO_ACTION mencatat risiko dalam email.warnings.

Opsi yang tersedia:

NO_ACTION,

DECLINE

enable_enrichment

boolean

default:false

Jika true, jalankan juga intelijen email pada alamat tersebut: skor risiko dan riwayat kebocorannya. Ditagihkan sebagai satu unit email_intelligence_api per permintaan ($0.05 pada harga terdaftar) di luar harga endpoint ini sendiri. Permintaan mengembalikan 403 jika saldo Anda tidak mencukupi.

Contoh:

false

email_intelligence_score_action

enum<string>

default:NO_ACTION

Tindakan saat skor risiko intelijen email berada di atas ambang batas. DECLINE mengubah status akhir menjadi Declined; NO_ACTION mencatat sinyal tanpa menolak. Hanya berlaku saat enable_enrichment bernilai true.

Opsi yang tersedia:

NO_ACTION,

DECLINE

recent_email_breach_action

enum<string>

default:NO_ACTION

Tindakan saat alamat muncul dalam kebocoran data terkini yang diketahui. DECLINE mengubah status akhir menjadi Declined; NO_ACTION mencatat sinyal tanpa menolak. Hanya berlaku saat enable_enrichment bernilai true.

Opsi yang tersedia:

NO_ACTION,

DECLINE

frequent_email_breach_action

enum<string>

default:NO_ACTION

Tindakan saat alamat muncul dalam banyak kebocoran data yang diketahui. DECLINE mengubah status akhir menjadi Declined; NO_ACTION mencatat sinyal tanpa menolak. Hanya berlaku saat enable_enrichment bernilai true.

Opsi yang tersedia:

NO_ACTION,

DECLINE

Jika true, cari juga jejak sosial alamat tersebut - platform email, sosial, profesional, e-commerce, dan hiburan tempat alamat tersebut terdaftar. Ditagih sebagai satu unit email_social per permintaan selain harga endpoint ini sendiri.

Contoh:

true

Tindakan saat pemeriksaan jejak sosial mendapati alamat tidak terdaftar di platform mana pun yang dicakup. Hanya NO_ACTION dan DECLINE yang diterima pada endpoint ini; REVIEW tersedia pada kunci konfigurasi alur kerja dengan nama yang sama.

Opsi yang tersedia:

NO_ACTION,

DECLINE

Respons

Pemeriksaan selesai — kode yang salah dan verifikasi yang tidak ditemukan juga mengembalikan 200; periksa status, bukan kode HTTP. email hanya diisi pada hasil akhir (Approved/Declined), null pada Failed, dan tidak ada pada Expired or Not Found.

request_id

string<uuid>

Pada Approved/Declined: ID sesi verifikasi yang cocok — identik dengan request_id yang dikembalikan oleh POST /v3/email/send/. Pada Failed dan Expired or Not Found: UUID acak sekali pakai yang tidak dapat dicari kemudian.

status

enum<string>

Approved — kode benar, tidak ada risiko penolakan. Declined — terminal: risiko penolakan cocok atau batas percobaan (3) telah habis. Failed — kode salah, percobaan masih tersisa. Expired or Not Found — tidak ada verifikasi tertunda untuk alamat ini dalam 5 menit terakhir.

Opsi yang tersedia:

Approved,

Declined,

Failed,

Expired or Not Found

message

string

Penjelasan hasil yang mudah dibaca manusia, termasuk jumlah percobaan yang tersisa setelah kode yang salah.

object | null

Laporan email lengkap. Ada (tidak bernilai null) hanya pada hasil akhir (Approved/Declined); bernilai null pada status Failed dan tidak ada pada Expired or Not Found.

Show child attributes

vendor_data

string | null

vendor_data dari sesi verifikasi yang cocok. null pada Expired or Not Found.

metadata

object | null

metadata dari sesi verifikasi yang cocok. null pada Expired or Not Found.

created_at

string<date-time>

Cap waktu respons pemeriksaan ini.

Terakhir diubah pada 7 November 2026

​Add-on Intelijen

Otorisasi

Body

Respons

Add-on Intelijen