Langsung ke konten utama
POST
curl

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
email
string<email>
wajib

Alamat email penerima. Alamat dengan format yang salah mengembalikan 400; alamat dengan sintaks yang valid tetapi tidak dapat menerima email (validasi DNS/MX gagal) mengembalikan 200 dengan status: "Undeliverable".

Contoh:

"alice@example.com"

options
object

Opsi format, lokalisasi, dan branding OTP. Semua kolom bersifat opsional.

signals
object

Sinyal perangkat dan jaringan opsional mengenai pengguna akhir, yang diteruskan ke lapisan anti-fraud untuk meningkatkan deteksi lalu lintas yang menyalahgunakan sistem atau dihasilkan secara otomatis. Semua kolom bersifat opsional.

vendor_data
string

Pengidentifikasi opsional yang dikontrol pemanggil (id pengguna internal Anda, email, UUID, dll.) yang disimpan pada sesi dan dikembalikan dalam respons pengiriman, respons pemeriksaan kecocokan, webhook, dan Business Console. Gunakan ini untuk menghubungkan request_id Didit dengan data pengguna Anda.

metadata
object | null

Objek JSON bentuk bebas opsional yang disimpan pada sesi dan dikembalikan dalam respons pengiriman, respons pemeriksaan pencocokan, webhook, dan Business Console.

Respons

Pengiriman dikonfirmasi. Periksa status: Success dan Retry berarti kode sedang dikirim; Undeliverable berarti alamat tidak dapat menerima surat dan verifikasi telah difinalisasi sebagai Declined. request_id adalah id sesi yang disimpan (id yang sama pada Retry).

request_id
string<uuid>

ID sesi verifikasi. Pengiriman Retry mengembalikan request_id yang sama dengan pengiriman asli. ID ini muncul di Business Console, dikembalikan lagi oleh POST /v3/email/check/ yang telah selesai diproses, dan dapat diteruskan ke GET /v3/session/{sessionId}/decision/.

status
enum<string>

Success — OTP dikirim via email untuk verifikasi baru (ditagih). Retry — OTP baru dikirim via email untuk verifikasi tertunda yang dibuat dari pengiriman sebelumnya (gratis). Undeliverable — alamat gagal dalam validasi keterkiriman atau pesan tidak dapat dikirim; verifikasi langsung diselesaikan sebagai Declined dan tidak ada biaya yang ditagih.

Opsi yang tersedia:
Success,
Retry,
Undeliverable
reason
enum<string> | null

email_can_not_be_delivered ketika status bernilai Undeliverable; selain itu null.

Opsi yang tersedia:
email_can_not_be_delivered,
null
vendor_data
string | null

Salinan vendor_data yang disimpan pada sesi (dari pengiriman pertama).

metadata
object | null

Salinan metadata yang disimpan pada sesi (dari pengiriman pertama).

Terakhir diubah pada 7 November 2026