Langsung ke konten utama
PATCH
curl
rotate_secret_key hanya merotasi rahasia tingkat aplikasi, yang menandatangani pengiriman ke webhook_url lama. Setiap tujuan webhook menandatangani dengan secret_shared_key-nya sendiri, dan panggilan ini tidak mengubahnya.
Kolom retensi mengikuti kebijakan yang sama dengan yang Anda atur di Business Console → App Settings → Data retention. Baca Retensi data sebelum mengubahnya, terutama retensi templat biometrik. allowed_return_hosts dijelaskan di Daftarkan tujuan pengembalian Anda. biometric_consent_mode (auto, always atau never) menentukan kapan alur verifikasi meminta persetujuan biometrik eksplisit sebelum pengambilan wajah. Lihat Persetujuan biometrik. Untuk membaca nilai saat ini terlebih dahulu, panggil Dapatkan Konfigurasi Webhook.

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

Kirim hanya kolom yang akan diubah. Tujuan tidak dikelola di sini.

webhook_url
string<uri> | null

URL webhook tingkat aplikasi lama. Didit menggunakannya hanya saat aplikasi tidak memiliki tujuan yang aktif, dan kemudian hanya untuk status.updated dan data.updated. Ini tidak membuat tujuan, dan pembuatan, pembaruan, atau penghapusan tujuan berikutnya akan menggantikannya. Untuk menerima webhook, buat tujuan dengan POST /v3/webhook/destinations/ sebagai gantinya.

Maximum string length: 2000
webhook_version
enum<string>

Versi payload dari webhook_url lama.

Opsi yang tersedia:
v1,
v2,
v3
rotate_secret_key
boolean
default:false

true mengganti secret_shared_key tingkat aplikasi dengan nilai acak baru secara langsung; nilai baru disertakan dalam respons. Rahasia tujuan tidak diubah. Setiap panggilan dengan true menghasilkan rahasia baru, sehingga tidak bersifat idempoten.

capture_method
enum<string>

Pengaturan aplikasi lama. Alur verifikasi tidak membacanya.

Opsi yang tersedia:
MOBILE,
MOBILE_AND_DESKTOP
data_retention_months
integer | null

Jendela penghapusan otomatis dalam bulan (satu bulan dihitung sebagai 30 hari), atau null untuk tanpa penghapusan otomatis. Perubahan juga berlaku untuk sesi yang ada: setiap sesi verifikasi pengguna yang lebih lama dari jendela baru akan dihapus secara otomatis, dan penghapusan tersebut tidak dapat dibatalkan.

Rentang yang diperlukan: 1 <= x <= 120
face_retention_policy
enum<string>

Hal yang terjadi pada embedding wajah sesi saat sesi dihapus. retain_until_user_deleted memerlukan face_retention_days dalam permintaan yang sama atau yang sudah diatur sebelumnya. Perubahan berlaku untuk penghapusan sesi setelahnya; perubahan ini tidak membuat atau menghapus secara permanen templat biometrik yang sudah ada.

Opsi yang tersedia:
delete_with_session,
retain_until_user_deleted
face_retention_days
integer | null

Periode retensi data, dalam hari, untuk templat biometrik di bawah retain_until_user_deleted.

Rentang yang diperlukan: 1 <= x <= 3650

Kapan alur yang di-hosting dan SDK native meminta persetujuan biometrik eksplisit dari pengguna sebelum pengambilan wajah. auto (default) hanya meminta jika pemicu berlaku: negara bagian yang dinyatakan, IP pengguna, atau penerbit dokumen identitas berada di Illinois, Texas, atau Colorado, atau pengguna tampaknya berada di AS tanpa negara bagian yang diketahui. always meminta kepada setiap pengguna yang alur kerjanya mengambil gambar wajah. never tidak pernah menampilkan langkah tersebut, dan Anda mengumpulkan persetujuan sendiri sebelum swafoto. Setiap perubahan dicatat dalam log audit. Lihat Persetujuan biometrik.

Opsi yang tersedia:
auto,
always,
never
allowed_return_hosts
string[]

Mengganti seluruh daftar host pengembalian dompet ID Digital. Hanya hostname murni, seperti shop.example.com: tanpa skema, port, path, atau wildcard. Nilai diubah menjadi huruf kecil dan duplikat dihapus. Kirim [] untuk mengosongkan daftar.

Maximum array length: 20
Maximum string length: 253
allowed_domains
string[]

Mengganti seluruh daftar origin yang diizinkan. Origin (misalnya https://app.example.com; http hanya untuk localhost) tempat alur verifikasi yang di-hosting dapat disematkan dan dapat mengarahkan pengguna kembali dengan callback sesi. Panggilan server-ke-server tidak terpengaruh. Daftar kosong berarti tidak ada batasan. Didit menyimpan setiap origin dalam huruf kecil tanpa port default. Entri yang tidak valid gagal dengan 400 pada allowed_domains. Kirim [] untuk menghapus batasan.

Maximum array length: 50
Maximum string length: 300
Contoh:

Respons

Konfigurasi lengkap setelah pembaruan, dengan struktur yang sama seperti GET /v3/webhook/. Saat Anda merotasi rahasia, simpan secret_shared_key baru sebelum Anda membuang respons.

Konfigurasi webhook tingkat aplikasi, kebijakan retensi, dan host pengembalian dompet Digital ID, beserta setiap tujuan webhook.

webhook_url
string<uri> | null
wajib

URL webhook tingkat aplikasi (lama). Didit hanya mengirim ke URL tersebut selama aplikasi tidak memiliki tujuan yang diaktifkan, dan setelah itu hanya status.updated dan data.updated. Setiap pembuatan, pembaruan, atau penghapusan tujuan akan menyetelnya ke URL tujuan aktif yang paling dahulu diaktifkan, atau null jika tidak ada yang diaktifkan.

webhook_version
enum<string>
wajib

Versi payload dari webhook_url lama. Setiap tujuan memiliki webhook_version miliknya sendiri.

Opsi yang tersedia:
v1,
v2,
v3
secret_shared_key
string
wajib

Rahasia penandatanganan tingkat aplikasi (token 43 karakter yang aman untuk URL). Ini hanya menandatangani pengiriman ke webhook_url lama; setiap tujuan menandatangani dengan secret_shared_key miliknya sendiri. Pemanggil yang menggunakan kunci API selalu menerimanya secara lengkap; pengguna Console tanpa read:webhooks menerima string kosong.

capture_method
enum<string>
wajib

Pengaturan aplikasi lama. Alur verifikasi tidak membacanya: opsi pengambilan dikonfigurasi per alur kerja.

Opsi yang tersedia:
MOBILE,
MOBILE_AND_DESKTOP
data_retention_months
integer | null
wajib

Jendela penghapusan otomatis. Sesi verifikasi pengguna yang dibuat lebih dari sekian bulan lalu (satu bulan dihitung 30 hari) akan dihapus secara otomatis, dan penghapusan tersebut bersifat tidak dapat dibatalkan. null berarti sesi tidak pernah dihapus secara otomatis. Lihat Retensi data.

Rentang yang diperlukan: 1 <= x <= 120
face_retention_policy
enum<string>
wajib

Hal yang terjadi pada embedding wajah sesi saat sesi dihapus. delete_with_session (default) menghapusnya bersama sesi. retain_until_user_deleted merupakan opsi retensi templat biometrik yang dipilih secara sukarela: templat biometrik bebas gambar yang ditautkan ke Pengguna dikelola secara terpisah hingga periode retensinya berakhir, Pengguna dihapus, atau Anda menghapusnya secara permanen.

Opsi yang tersedia:
delete_with_session,
retain_until_user_deleted
face_retention_days
integer | null
wajib

Periode retensi data, dalam hari, untuk templat biometrik di bawah retain_until_user_deleted. Wajib diisi jika kebijakan tersebut diatur.

Rentang yang diperlukan: 1 <= x <= 3650
available_events
object[]
wajib

Setiap tipe event yang dapat dilanggan oleh tujuan, dengan label tampilan.

allowed_return_hosts
string[]
wajib

Nama host (kecocokan persis, hanya HTTPS) tempat verifikasi dompet Digital ID mandiri dapat mengarahkan pengguna kembali dengan return_url-nya. Domain White Label Anda juga selalu diizinkan. Lihat Daftarkan tujuan pengembalian Anda.

Maximum array length: 20
Maximum string length: 253
endpoints
object[]
wajib

Setiap tujuan webhook dari aplikasi, yang terlama terlebih dahulu, masing-masing dengan rahasia penandatangannya. Hanya dapat dibaca di sini: kelola tujuan dengan endpoint /v3/webhook/destinations/.

Kapan alur yang di-hosting dan SDK native meminta persetujuan biometrik eksplisit dari pengguna sebelum pengambilan wajah. auto (default) hanya meminta jika pemicu berlaku: negara bagian yang dinyatakan, IP pengguna, atau penerbit dokumen identitas berada di Illinois, Texas, atau Colorado, atau pengguna tampaknya berada di AS tanpa negara bagian yang diketahui. always meminta kepada setiap pengguna yang alur kerjanya mengambil gambar wajah. never tidak pernah menampilkan langkah tersebut, dan Anda mengumpulkan persetujuan sendiri sebelum swafoto. Setiap perubahan dicatat dalam log audit. Lihat Persetujuan biometrik.

Opsi yang tersedia:
auto,
always,
never
allowed_domains
string[]

Asal (misalnya https://app.example.com; http hanya untuk localhost) tempat alur verifikasi yang di-hosting dapat disematkan dan dapat mengarahkan pengguna kembali dengan callback sesi. Panggilan server-ke-server tidak terpengaruh. Daftar kosong berarti tidak ada batasan. Didit menyimpan setiap origin dalam huruf kecil tanpa port default. Entri yang tidak valid gagal dengan 400 pada allowed_domains.

Maximum array length: 50
Maximum string length: 300
Contoh:
Terakhir diubah pada 7 November 2026