Langsung ke konten utama
PATCH
cURL
Gunakan PATCH untuk pembaruan parsial. Untuk mengganti nama alur kerja, kirim hanya workflow_label.
Untuk mengubah pemeriksaan dalam alur kerja, kirim seluruh array features yang Anda inginkan. Ini akan menggantikan urutan fitur dan konfigurasi sebelumnya.
API v3 membuat alur kerja tetap sederhana: satu jalur linear dan satu langkah status akhir. Percabangan, node tindakan, dan node webhook tidak diterima di sini.

Referensi konfigurasi fitur

Saat Anda mengirim features dalam PATCH, array tersebut menggantikan urutan fitur dan konfigurasi sebelumnya. Sertakan kembali setiap konfigurasi yang wajib. Objek config yang tepat bergantung pada fiturnya. Tinjau daftar kolom lengkap, nilai default, pengaturan wajib, rentang nilai, dan contohnya di Konfigurasi Fitur Alur Kerja. Untuk OCR, hilangkan config.documents_allowed, kirim null, atau kirim {} untuk mengizinkan semua jenis dokumen yang didukung. Sertakan hanya jika Anda ingin membatasi alur kerja ke negara atau jenis dokumen tertentu. Untuk QUESTIONNAIRE, config.questionnaire_uuid wajib diisi.

Memperbarui pengaturan alur kerja

Anda dapat mem-patch pengaturan tingkat sesi tanpa mengubah daftar fitur. Kirim hanya kolom yang ingin Anda ubah.
Gunakan uuid alur kerja yang dikembalikan oleh endpoint list, create, atau get sebagai settings_uuid dalam URL ini.

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

settings_uuid
string<uuid>
wajib

UUID per versi dari alur kerja yang akan diperbarui.

Body

application/json

Perbarui metadata alur kerja atau ganti seluruh daftar fitur linear. Daftar putih kolom yang KETAT: kunci apa pun yang tidak tercantum di sini akan ditolak dengan respons 400.

workflow_label
string

Nama tampilan untuk alur kerja (maksimal 50 karakter).

Maximum string length: 50
is_default
boolean

Atur alur kerja ini sebagai default untuk sesi baru.

status
enum<string>

Mengontrol versi. Jangan sertakan untuk memperbarui versi saat ini di tempat (draf dipublikasikan secara otomatis). published pada versi yang sudah dipublikasikan akan membuat dan mengembalikan versi BARU. draft hanya valid selama versi tersebut masih berupa draf.

Opsi yang tersedia:
draft,
published
features
object[]

Jika diberikan, ini menggantikan urutan dan konfigurasi fitur secara menyeluruh.

Minimum array length: 1
is_white_label_enabled
boolean

Aktifkan kustomisasi White Label untuk sesi yang dibuat dengan alur kerja ini.

is_desktop_allowed
boolean

Izinkan alur verifikasi berjalan di browser desktop.

max_retry_attempts
integer

Upaya coba lagi maksimum yang diizinkan setelah verifikasi yang ditolak. 0 memblokir pengguna setelah penolakan pertama.

Rentang yang diperlukan: 0 <= x <= 10
retry_window_days
integer | null

Jendela bergulir dalam hitungan hari yang digunakan untuk menghitung percobaan ulang. null memberlakukan batas sepanjang masa.

Rentang yang diperlukan: 1 <= x <= 365
face_liveness_max_attempts
integer

Pengiriman deteksi liveness maksimum per sesi. Nilai ini juga disalin ke dalam node alur kerja deteksi liveness dan estimasi usia yang dibuat kecuali ditimpa oleh konfigurasi tingkat fitur.

Rentang yang diperlukan: 1 <= x <= 3
face_match_max_attempts
integer

Pengiriman pencocokan wajah maksimum per sesi. Nilai ini juga disalin ke dalam node alur kerja pencocokan wajah yang dibuat kecuali ditimpa oleh konfigurasi tingkat fitur.

Rentang yang diperlukan: 1 <= x <= 3
session_expiration_time
integer

Detik sebelum sesi yang belum selesai kedaluwarsa. Minimum 1 jam (3600), maksimum 4 minggu (2419200).

Rentang yang diperlukan: 3600 <= x <= 2419200

Respons

Alur kerja diperbarui. Isi adalah konfigurasi PENUH dari versi yang dihasilkan (bentuk mentah VerificationSettings yang sama seperti GET /v3/workflows/{settings_uuid}/). Ketika pembaruan membuat versi baru (status: "published" dikirim pada baris yang dipublikasikan), uuid dan version yang dikembalikan berbeda dari yang Anda ubah — gunakan uuid yang dikembalikan untuk panggilan berikutnya.

Kolom di bawah ini memiliki tipe; objek ini juga memuat setiap kolom lain dari konfigurasi alur kerja (pengalih fitur, ambang batas, tindakan peringatan, dokumen yang diizinkan, callback) sebagai properti tambahan. Kolom yang tidak berlaku untuk workflow_type bernilai null.

uuid
string<uuid>

Pengidentifikasi per versi (settings_uuid). Setiap versi alur kerja memiliki pengidentifikasi tersendiri.

workflow_id
string<uuid>

Pengidentifikasi stabil yang digunakan bersama oleh setiap versi alur kerja. Sesi yang dibuat dengannya menggunakan versi terbaru yang dipublikasikan.

workflow_label
string

Nama tampilan alur kerja.

workflow_type
enum<string> | null

Templat alur kerja. null untuk alur kerja graf yang dibuat tanpa templat.

Opsi yang tersedia:
kyc,
kyb,
adaptive_age_verification,
biometric_authentication,
address_verification,
questionnaire_verification,
email_verification,
phone_verification,
null
is_default
boolean

Apakah ini merupakan alur kerja default aplikasi.

is_archived
boolean

Alur kerja yang diarsipkan tidak dapat memulai sesi baru.

version
integer

Nomor versi dalam alur kerja.

status
enum<string>

Versi draf dapat diedit; versi yang dipublikasikan bersifat tidak dapat diubah dan digunakan untuk sesi baru.

Opsi yang tersedia:
draft,
published
published_at
string<date-time> | null

Kapan versi ini dipublikasikan. null untuk draf.

is_simple_workflow
boolean

true saat alur kerja tidak memiliki workflow_graph khusus.

is_editable
boolean

true hanya untuk versi draft.

workflow_url
string<uri>

URL publik yang memulai sesi dengan alur kerja ini.

workflow_graph
object | null

Struktur graf alur kerja (node dan edge). null untuk alur kerja sederhana.

features
string

Fitur yang diaktifkan digabungkan dengan " + ", misalnya "OCR + LIVENESS".

total_price
number | null

Harga per sesi; untuk alur kerja graf, merupakan jalur termahal.

min_price
number | null

Harga jalur termurah melalui alur kerja.

max_price
number | null

Harga jalur termahal melalui alur kerja.

special_add_on_prices
object | null

Harga add-on khusus organisasi, atau null jika tidak ada yang diatur.

max_retry_attempts
integer

Jumlah coba lagi yang diizinkan setelah verifikasi ditolak.

retry_window_days
integer | null

Jumlah hari selama percobaan ulang diizinkan.

session_expiration_time
integer

Detik sebelum sesi yang belum selesai kedaluwarsa.

questionnaire
object | null

Kuesioner yang dilampirkan pada alur kerja, atau null.

kyb_role_settings
object[]

Pengaturan verifikasi per peran untuk pihak kunci KYB.

created_at
string<date-time>
updated_at
string<date-time>
signature_availability
object

Tingkat Tanda Tangan Elektronik mana yang dapat digunakan untuk menandatangani saat ini. Periksa ini sebelum Anda menyetel signature_level. Dikembalikan pada alur kerja kyc, kyb, dan graf.

is_bank_verification_enabled
boolean

Menentukan apakah alur kerja KYC atau KYB sederhana menjalankan verifikasi Bank. Verifikasi ini berjalan setelah langkah kontak (dan verifikasi Lokasi) dan sebelum validasi database, AML, serta analisis IP. Verifikasi Bank belum tersedia secara umum: mengaktifkannya ditolak di mana pun fitur ini belum diaktifkan.

bank_verification_config
object

Pengaturan verifikasi bank dari alur kerja sederhana, dengan kunci yang sama seperti yang diterima node BANK_VERIFICATION (misalnya bank_countries dan bank_method_order). Kunci yang tidak dikenal akan dibuang. Setiap kunci bersifat opsional dan kunci yang tidak ada akan menggunakan nilai default-nya, sehingga {} berarti semua nilai default. Lihat Pengaturan verifikasi bank.

Contoh:
is_geolocation_enabled
boolean

Menentukan apakah alur kerja KYC sederhana menjalankan verifikasi Lokasi. Verifikasi ini berjalan setelah langkah kontak dan sebelum verifikasi Bank serta validasi database. Alur kerja Bisnis (KYB) tidak dapat menjalankannya.

geolocation_config
object

Pengaturan verifikasi lokasi dari alur kerja sederhana, dengan kunci yang sama seperti yang diterima node GEOLOCATION (misalnya is_geolocation_geofencing_enabled dan geolocation_max_attempts). Kunci yang tidak dikenal akan diabaikan. Setiap kunci bersifat opsional dan kunci yang tidak ada akan menggunakan nilai default-nya, sehingga {} berarti semua nilai default.

Contoh:
Terakhir diubah pada 7 November 2026