Langsung ke konten utama
POST
Python
Melakukan pratinjau tidak mengubah sesi atau mengirim email. Setelah meninjau respons, konfirmasi dengan Perbarui Status Sesi dan kirimkan preview_token yang dikembalikan sebagai email_preview_token. Tanda terima pratinjau kedaluwarsa setelah 15 menit. Tanda terima yang berubah atau sudah kedaluwarsa mengembalikan 409 sebelum sesi diubah atau email dikirim. Buat pratinjau baru setelah terjadi konflik. Integrasi API yang sudah ada boleh tidak menyertakan tanda terima; konsol menyediakannya saat Anda mengonfirmasi pratinjau. Pengirim dan identitas merek mengikuti konfigurasi White Label Anda yang sudah ada. Isi pesan berasal dari templat verifikasi yang diterjemahkan; subjek, isi pesan, dan URL tindakan yang ditentukan sendiri tidak diterima sebagai input templat.

Siapa yang menerima email

email_address bersifat opsional. Jika tidak diisi, email dikirim ke alamat pengguna akhir sendiri: alamat yang diverifikasi pada langkah verifikasi email dalam alur, atau jika tidak ada, alamat yang diberikan di contact_details saat sesi dibuat. Alamat yang Anda kirimkan di email_address selalu diutamakan. recipient_source menunjukkan alamat mana yang berlaku:

Apakah email dikirim

will_be_sent bernilai true ketika konfirmasi pengiriman ulang dengan send_email: true mengirim email. Jika bernilai false, not_sent_reason menjelaskan alasannya:

Konfirmasi pengiriman ulang

Panggil Perbarui Status Sesi dengan kolom berikut: language dalam respons adalah bahasa yang digunakan untuk menulis email: bahasa Inggris jika bahasa yang Anda minta tidak tersedia.

Pengiriman ulang berulang hanya di backend

Ketika setiap langkah yang akan dikirim ulang berjalan tanpa pengguna (AML, Validasi Database, atau Analisis IP), sesi hanya dapat dikirim ulang untuk pengguna tersebut sekali setiap 30 detik. Dalam jendela waktu tersebut, pratinjau mengembalikan 429, sama seperti Perbarui Status Sesi, dengan waktu tunggu di header Retry-After.

Terkait

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.

Parameter Path

sessionId
string<uuid>
wajib

UUID sesi verifikasi yang akan diperbarui. Menerima ID sesi pengguna (KYC) dan bisnis (KYB) — layanan mencari ID tersebut di kedua jenis sesi.

Contoh:

"11111111-2222-3333-4444-555555555555"

Body

application/json
nodes_to_resubmit
object[]

Langkah-langkah yang akan dipratinjau, menggunakan validasi, pemilihan, dan urutan alur kerja yang sama seperti pengiriman ulang. Jangan sertakan untuk memilih otomatis percobaan tercatat yang memerlukan pengiriman ulang.

email_address
string<email>

Opsional. Kirim email ke alamat ini alih-alih alamat orang itu sendiri. Tanpa parameter ini, penerima adalah alamat yang diverifikasi orang tersebut dalam alur, atau yang diberikan di contact_details. Tidak ada email yang dikirim oleh panggilan ini.

Contoh:

"user@example.com"

email_language
string
default:en

Bahasa untuk email notifikasi. Menerima string apa pun pada tingkat skema; kode yang tidak didukung akan beralih ke bahasa Inggris (en) secara senyap.

Contoh:

"en"

Respons

Hanya pratinjau. Sesi tidak berubah dan tidak ada email yang dikirim.

recipient
string
wajib

Alamat tujuan pengiriman email. String kosong jika tidak ada alamat yang diketahui untuk orang tersebut: maka tidak ada email yang dapat dikirim dan preview_token juga kosong. Teruskan sebagai email_address saat Anda mengonfirmasi.

Contoh:

"person@example.com"

recipient_source
enum<string>
wajib

Dari mana asal recipient. request: email_address yang Anda teruskan. email_verification: alamat yang diverifikasi orang tersebut dalam langkah verifikasi email pada alur. contact_details: alamat yang diberikan dalam contact_details saat sesi dibuat. Berupa string kosong jika tidak ada alamat.

Opsi yang tersedia:
email_verification,
contact_details,
request,
Contoh:

"email_verification"

sender
string
wajib

Header From yang digunakan untuk mengirim email.

Contoh:

"Example App <no-reply@mail.example.com>"

sender_name
string
wajib

Bagian nama tampilan dari sender.

Contoh:

"Example App"

sender_email
string<email>
wajib

Bagian alamat dari sender.

Contoh:

"no-reply@mail.example.com"

sender_kind
enum<string>
wajib

customer: email dikirim dari domain pengirim terverifikasi aplikasi Anda (White Label). didit: email dikirim dari pengirim Didit sendiri.

Opsi yang tersedia:
customer,
didit
Contoh:

"customer"

subject
string
wajib

Baris subjek persis seperti yang dikirimkan.

Contoh:

"Action Required: Complete your verification in Example App"

html
string
wajib

HTML email persis seperti yang dikirim, dengan logonya disematkan sebagai URL data. Render dalam frame sandbox, jangan pernah langsung di DOM aplikasi Anda.

Contoh:

"<!DOCTYPE html><html><body>...</body></html>"

text
string
wajib

Kata-kata email sebagai teks biasa, sebagaimana disimpan dalam utas Pesan orang tersebut, untuk pratinjau ringkas (HTML tetap berupa email yang diterima orang tersebut).

Contoh:

"Almost there\n\nSome steps need to be completed again.\nHere’s what to fix:\n\nhttps://verify.didit.me/session/abc123"

language
string
wajib

Bahasa penulisan email. Bahasa Inggris (en) saat email_language yang Anda minta tidak tersedia.

Contoh:

"en"

will_be_sent
boolean
wajib

Menentukan apakah mengonfirmasi perubahan dengan send_email: true mengirimkan email ini. false jika not_sent_reason diatur.

Contoh:

true

not_sent_reason
enum<string> | null
wajib

Alasan mengapa konfirmasi tidak akan mengirim email, atau null jika akan dikirim. no_user_action: setiap langkah yang dipilih berjalan tanpa orang tersebut, sehingga pengiriman ulang selesai dengan sendirinya dan tidak ada email yang dikirim. no_recipient: tidak ada alamat yang diketahui untuk orang tersebut dan Anda tidak meneruskannya. sandbox: sesi sandbox yang penerimanya belum menyetujui pengiriman email sandbox, sehingga pengiriman hanya disimulasikan.

Opsi yang tersedia:
no_user_action,
no_recipient,
sandbox,
null
Contoh:

null

nodes_to_resubmit
object[]
wajib
requires_user_action
boolean
wajib

Menentukan apakah setidaknya satu pemeriksaan yang dipilih memerlukan interaksi pengguna. Ini tidak memprediksi hasil akhir alur kerja.

preview_token
string
wajib

Tanda terima yang ditandatangani untuk email persis ini, valid selama 15 menit. Teruskan sebagai email_preview_token ke Perbarui Status Sesi. String kosong jika tidak ada penerima.

Contoh:

"eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000"

Terakhir diubah pada 7 November 2026