Langsung ke konten utama
PATCH
curl

Ikhtisar

Memperbarui kolom yang dapat diubah pada entitas Pengguna. Kolom yang berasal dari sesi Verifikasi Pengguna (KYC) yang telah terverifikasi (full_name, date_of_birth, portrait_image, penghitung agregat, features) bersifat hanya-baca.

Kapan digunakan

  • Perbarui metadata Anda sendiri — pindahkan pengguna ke tingkat lain, ubah tag, buat catatan internal.
  • Ubah nama — tetapkan display_name yang lebih baik untuk tampilan konsol internal.
  • Timpa data terverifikasi (dengan hati-hati) — penimpaan manual diizinkan tetapi dicatat di log audit.

Catatan

  • vendor_data di URL tidak dapat diubah melalui endpoint ini. Buat pengguna baru dan hapus yang lama jika Anda perlu mengganti kunci.
  • Mengirimkan webhook user.data.updated dengan array changed_fields agar konsumen dapat menyinkronkan data secara efisien.
  • Perubahan status di sini berfungsi seperti Perbarui Status Pengguna. Perubahan ini dicatat dalam aktivitas pengguna tersebut, dengan reason opsional (hingga 1000 karakter) sebagai komentarnya, dan BLOCKED menambahkan vendor_data ke daftar blokir sistem. Webhook user.status.updated tidak memuat reason.
  • Jika Anda melakukan PATCH pada kolom yang saat ini dikelola oleh sesi terverifikasi, penimpaan akan diterima tetapi ditandai di log audit.

Izin

Rahasia utama dan kunci API dengan akses penuh selalu dapat memanggil endpoint ini. Kunci dengan akses kustom memerlukan izin tulis untuk Orang (users). Kunci yang dibatasi hanya untuk alur kerja tertentu atau sesi yang disetujui tidak dapat mengakses endpoint ini. Peran dan izin di Konsol menentukan apa yang dapat dilakukan anggota tim di Konsol. Keduanya tidak dievaluasi untuk permintaan melalui kunci API.

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

vendor_data
string
wajib

Pengidentifikasi unik Anda untuk pengguna (string bentuk bebas, BUKAN UUID).

Body

application/json
full_name
string | null

Nama lengkap pengguna

Maximum string length: 512
display_name
string | null

Nama tampilan kustom untuk pengguna ini

date_of_birth
string<date> | null

Tanggal lahir dalam format YYYY-MM-DD

status
enum<string>

Status siklus hidup pengguna. Perubahan dicatat sebagai aktivitas STATUS_CHANGED, dan BLOCKED menambahkan vendor_data ke daftar blokir sistem (berpindah dari BLOCKED akan menghapus entri tersebut).

Opsi yang tersedia:
ACTIVE,
FLAGGED,
BLOCKED
metadata
object | null

Objek JSON arbitrer yang Anda lampirkan ke pengguna. Menggantikan sepenuhnya metadata yang ada saat pembaruan — gabungkan di sisi klien jika Anda hanya ingin menambahkan kunci.

approved_emails
string[]

Alamat email terverifikasi untuk pengguna ini, contoh ["john@example.com"]. Menggantikan daftar yang tersimpan sepenuhnya.

approved_phones
string[]

Nomor telepon terverifikasi untuk pengguna ini. Menggantikan daftar yang tersimpan sepenuhnya.

issuing_states
string[]

Negara penerbit (ISO 3166-1 alpha-3), mis. ["USA"]. Menggantikan sepenuhnya daftar yang tersimpan.

reason
string | null

Alasan mengapa status berubah. Dicatat pada entri perubahan status aktivitas pengguna (comments[].comment, dan Activity di Business Console), hanya jika status benar-benar berubah. Webhook tidak menyertakannya.

Maximum string length: 1000

Respons

Pengguna diperbarui. Rekor pengguna lengkap yang diperbarui (bentuk yang sama seperti Dapatkan Pengguna) dikembalikan.

Detail pengguna lengkap. Memperluas UserListItem dengan metadata, komentar, dan updated_at.

didit_internal_id
string<uuid>

UUID internal yang stabil dari Didit untuk pengguna ini.

vendor_data
string | null

Pengidentifikasi unik Anda untuk pengguna ini (diteruskan saat membuat sesi). Nilai ini dapat berupa null jika tidak ada pengidentifikasi vendor yang diberikan.

display_name
string | null

Nama tampilan kustom yang Anda tetapkan

full_name
string | null

Nama lengkap yang diekstrak dari dokumen yang diverifikasi

date_of_birth
string<date> | null
effective_name
string | null

Nama terbaik yang tersedia: display_name jika disetel, selain itu full_name

status
enum<string>

Status siklus hidup rekaman pengguna (BUKAN status sesi). ACTIVE adalah default, FLAGGED menandai pengguna untuk perhatian manual, BLOCKED mencegah sesi baru untuk vendor_data ini.

Opsi yang tersedia:
ACTIVE,
FLAGGED,
BLOCKED
portrait_image_url
string | null

URL presigned untuk foto potret pengguna (kedaluwarsa setelah beberapa jam)

session_count
integer

Jumlah total sesi verifikasi untuk pengguna ini

approved_count
integer

Jumlah sesi yang disetujui

declined_count
integer

Jumlah sesi yang ditolak

in_review_count
integer

Jumlah sesi dalam peninjauan

issuing_states
string[]

Kode ISO 3166-1 alpha-3 dari negara penerbit yang terlihat pada dokumen ID pengguna yang disetujui ini, misalnya ["USA", "ESP"]. Berupa array kosong jika tidak ada.

approved_emails
string[]

Alamat email terverifikasi yang dikumpulkan dari sesi pengguna ini yang disetujui, contoh ["john@example.com"].

approved_phones
string[]

Nomor telepon terverifikasi yang dikumpulkan dari sesi pengguna ini yang disetujui, contoh ["+14155551234"].

features
object

Status per-fitur agregat di semua sesi pengguna ini. Kunci yang memungkinkan: ID_VERIFICATION, NFC, LIVENESS, FACE_MATCH, POA, QUESTIONNAIRE, EMAIL_VERIFICATION, PHONE, AML, IP_ANALYSIS, AGE_ESTIMATION, DATABASE_VALIDATION. Nilai yang memungkinkan: Approved, Declined, In Review, Not Finished, Resub Requested.

features_list
object[]

Data yang sama dengan features, sebagai array berurutan dari objek {feature, status}.

last_session_at
string<date-time> | null

Cap waktu sesi terbaru

first_session_at
string<date-time> | null

Cap waktu sesi pertama

last_activity_at
string<date-time> | null

Cap waktu aktivitas terbaru pada pengguna ini (sesi, transaksi, perubahan status, pengeditan data, dll.).

tags
object[]

Penetapan tag. CATATAN: pada respons detail, setiap entri berupa objek tautan tag ({uuid, tag: {...}, added_by_email, added_by_name, created_at}), berbeda dengan format datar {uuid, name, color} yang digunakan pada respons daftar.

created_at
string<date-time>
metadata
object

JSON metadata kustom yang Anda lampirkan ke pengguna ini. Default adalah {}.

comments
object[]

Log aktivitas dan komentar untuk pengguna ini (perubahan status, pengeditan profil, catatan manual).

updated_at
string<date-time>
Terakhir diubah pada 7 November 2026