Langsung ke konten utama
POST
curl
Pratinjau tidak mengubah apa pun dan tidak mengirim apa pun. Respons menampilkan email persis seperti yang diterima orang tersebut saat Anda mengatur sesi ke Approved atau Declined dengan send_email: true. Respons juga memberi tahu Anda siapa yang menerimanya, dari siapa email tersebut berasal, dan apakah konfirmasi benar-benar mengirimkannya.

Siapa yang menerima email

Email dikirim ke alamat milik orang tersebut sendiri: alamat yang ia verifikasi pada langkah Verifikasi Email dalam alur, atau jika tidak ada, alamat yang diberikan di contact_details saat sesi dibuat. recipient_source menunjukkan alamat mana yang berlaku (email_verification atau contact_details). Jika sesi tidak memiliki alamat untuk orang tersebut, recipient, recipient_source dan preview_token berisi string kosong, dan email tidak dapat dikirim. Email dikirim dari domain pengirim aplikasi Anda yang terverifikasi jika konfigurasi White Label Anda berlaku (sender_kind: customer), jika tidak, email dikirim dari pengirim Didit (sender_kind: didit).

Apakah email dikirim

will_be_sent bernilai true jika konfirmasi perubahan dengan send_email: true mengirim email. Jika bernilai false, not_sent_reason menjelaskan alasannya:

Konfirmasi keputusan

Panggil Update Session Status dengan kolom berikut: Tanda terima berlaku selama 15 menit. Jika penerima, bahasa, status sesi, pengirim, atau email berubah sejak pratinjau, pembaruan mengembalikan 409 sebelum ada yang berubah. Lakukan pratinjau lagi dan konfirmasi dengan tanda terima yang baru.

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. Menerima ID sesi pengguna (KYC) dan bisnis (KYB).

Contoh:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Body

application/json
new_status
enum<string>
wajib

Keputusan yang email-nya ingin Anda pratinjau.

Opsi yang tersedia:
Approved,
Declined
Contoh:

"Approved"

email_language
string
default:en

Bahasa email, default yang sama dengan Perbarui Status Sesi. Bahasa yang tidak ditawarkan beralih ke bahasa Inggris; language dalam respons menunjukkan bahasa mana yang digunakan.

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. 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,
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:

"Your verification has been approved 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:

"Verification Approved\n\nYour identity has been successfully verified with Acme Pay. No further action is needed on your part."

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. status_unchanged: sesi sudah memiliki status ini, sehingga pembaruan tidak mengubah apa pun dan tidak mengirim apa pun. notification_emails_disabled: sesi dibuat tanpa contact_details.send_notification_emails: true, sehingga tidak ada email keputusan yang dikirim ke alamat yang diberikan di contact_details. no_recipient: tidak ada alamat yang diketahui untuk pengguna tersebut. sandbox: sesi sandbox yang penerimanya belum menyetujui pengiriman email sandbox, sehingga pengiriman hanya disimulasikan.

Opsi yang tersedia:
status_unchanged,
notification_emails_disabled,
no_recipient,
sandbox,
null
Contoh:

null

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