API Manajemen Pengguna: CRUD Pengguna Vendor Didit

Pengelolaan entitas Pengguna inti dilakukan melalui endpoint publik di bawah /v3/users/. Lampiran profil, seperti unggahan wajah yang diimpor, menggunakan jalur organisasi/aplikasi dengan didit_internal_id. Halaman ini memberi Anda gambaran konseptual. Untuk skema permintaan dan respons lengkap, lihat referensi API.

Daftar pengguna

GET /v3/users/ Mengembalikan daftar pengguna dengan paginasi untuk aplikasi Anda. Mendukung filter berdasarkan status, pencarian, rentang tanggal, dan lainnya.

curl -G https://verification.didit.me/v3/users/ \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "status=ACTIVE" \
  --data-urlencode "search=jane" \
  --data-urlencode "page_size=50"

Contoh penggunaan:

Sinkronkan sebagian pengguna ke gudang data Anda setiap hari.
Temukan pengguna yang ditandai untuk antrean analis.
Cari pengguna berdasarkan nama tampilan.

Ambil satu pengguna

GET /v3/users/{vendor_data}/ Ambil satu pengguna berdasarkan vendor_data. Mengembalikan model data lengkap, termasuk penghitung agregat.

curl https://verification.didit.me/v3/users/user-42/ \
  -H "x-api-key: YOUR_API_KEY"

vendor_data di URL peka huruf besar-kecil. Selalu gunakan nilai persis yang Anda pakai saat membuat sesi.

Buat pengguna

POST /v3/users/create/ Buat entitas Pengguna sebelum sesi apa pun berjalan. Berguna untuk:

Menyiapkan metadata atau kolom kustom sebelum pelanggan melakukan verifikasi.
Menetapkan status awal (misalnya FLAGGED saat tim onboarding Anda meninjau dokumen secara manual).
Memuat pengguna dari database yang sudah ada agar Anda memiliki daftar lengkap sejak hari pertama.

curl -X POST https://verification.didit.me/v3/users/create/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "vendor_data": "user-42",
    "display_name": "Jane Doe",
    "metadata": { "tier": "premium", "signup_source": "web" }
  }'

Jika pengguna dengan vendor_data tersebut sudah ada, panggilan akan mengembalikan error konflik. Gunakan PATCH untuk memperbaruinya. Anda juga dapat mengirim detail kontak: first_name dan last_name (digabungkan menjadi full_name jika Anda tidak mengirimnya), email, phone_number, dan country. Didit menyimpan email dan phone_number di metadata.contact, dan country di metadata.address. Untuk mengundang orang tersebut melakukan verifikasi dalam panggilan yang sama, tambahkan send_verification_link: true beserta email dan workflow_id. Didit membuat sesi verifikasi untuk orang tersebut pada alur kerja itu dan mengirimkan tautannya melalui email. Objek verification_link dalam respons memuat session_id, session_number, status, url, workflow_id, dan email dari sesi, dan bernilai null jika Anda tidak meminta tautan. Lihat Buat Pengguna untuk pemeriksaan dan kesalahan.

Unggah wajah yang diimpor

POST /v3/organization/{organization_id}/application/{application_id}/vendor-users/by-id/{didit_internal_id}/faces/upload/ Lampirkan gambar wajah tepercaya ke profil Pengguna yang sudah ada. Langkah lanjutan ini tepat jika Anda mengimpor pengguna dari penyedia lain dan ingin Didit menyimpan bukti wajah mereka sebelum sesi Didit pertama.

# First create or retrieve the User and read didit_internal_id from the response.
curl -X POST https://verification.didit.me/v3/organization/$ORGANIZATION_ID/application/$APPLICATION_ID/vendor-users/by-id/$DIDIT_INTERNAL_ID/faces/upload/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "image": "<base64-encoded-jpg-or-png>",
    "comment": "Imported from previous KYC provider"
  }'

Lihat Unggah Wajah Pengguna untuk kolom permintaan, batas, endpoint daftar dan hapus, serta perbedaannya dengan daftar blokir.

Perbarui pengguna

PATCH /v3/users/{vendor_data}/ Perbarui kolom profil yang dapat diubah. Sebagian besar kolom yang berasal dari sesi terverifikasi bersifat hanya baca. Upaya mengubahnya melalui PATCH akan diabaikan atau dicatat di log audit. Kolom yang dapat diubah: display_name, metadata, tags. Hanya baca setelah verifikasi: full_name, date_of_birth, portrait_image, semua penghitung agregat, dan peta features.

curl -X PATCH https://verification.didit.me/v3/users/user-42/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "metadata": { "tier": "enterprise" } }'

Mengirimkan event webhook user.data.updated dengan larik changed_fields.

Ubah status

PATCH /v3/users/{vendor_data}/update-status/ Pindahkan pengguna di antara ACTIVE, FLAGGED, dan BLOCKED. Perubahan status berlaku untuk sesi dan transaksi berikutnya.

curl -X PATCH https://verification.didit.me/v3/users/user-42/update-status/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "BLOCKED",
    "reason": "Chargeback fraud pattern detected"
  }'

Dari → ke	Pemicu umum
`ACTIVE` → `FLAGGED`	Aturan transaksi, tinjauan analis, temuan Pemantauan AML Berkelanjutan
`ACTIVE` → `BLOCKED`	Penipuan yang dikonfirmasi, entri daftar blokir manual, kecocokan daftar blokir
`FLAGGED` → `ACTIVE`	Analis membersihkan hasil tinjauan
`BLOCKED` → `ACTIVE`	Pembukaan blokir manual oleh analis

Mengirimkan event webhook user.status.updated.

Hapus pengguna (massal)

POST /v3/users/delete/ Hapus satu atau beberapa pengguna. Catatan pengguna dihapus secara permanen, bersama setiap templat biometrik yang disimpan untuk mereka setelah sesi dihapus. Sesi verifikasi mereka tidak tercakup oleh endpoint ini dan tetap ada dengan tautannya ke pengguna dihapus; hapus sesi tersebut dengan Hapus Sesi atau Hapus Sesi secara Massal. Transaksi juga tidak tercakup; hapus transaksi tersebut dari Console.

curl -X POST https://verification.didit.me/v3/users/delete/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "vendor_data_list": ["user-42", "user-43", "user-44"]
  }'

Pilih pengguna berdasarkan vendor_data_list, didit_internal_id_list, atau keduanya sekaligus; atau kirim delete_all: true untuk menghapus setiap pengguna di aplikasi. Parameter massal filter_* dari Console ditolak di sini dengan 400, bukan diabaikan, sehingga permintaan yang dipersempit tidak pernah berubah menjadi penghapusan total. Mengembalikan jumlah, {"deleted": <int>}, bukan hasil per item. Pengidentifikasi yang tidak cocok dilewati tanpa pemberitahuan, jadi kirim daftar yang sudah tanpa duplikat jika Anda ingin membandingkan deleted dengan jumlah identifier yang Anda kirim.

Model izin

Kunci API dimiliki oleh satu aplikasi. Rahasia utama dan kunci akses penuh dapat memanggil setiap endpoint /v3/users/* milik aplikasi tersebut, termasuk delete. Kunci API dengan cakupan membutuhkan akses People (users): baca untuk endpoint GET, dan tulis untuk membuat, memperbarui, mengubah status, dan menghapus. Membuat pengguna dengan send_verification_link: true juga membutuhkan akses tulis Sessions, karena membuat sesi dan mengirimkan tautannya melalui email. Kunci yang tidak memiliki akses yang dibutuhkan akan merespons 403. Kunci yang dibatasi ke sebagian alur kerja atau ke sesi yang disetujui sama sekali tidak dapat mengakses endpoint /v3/users/*. Peran adalah konsep Console: izin sumber daya users dan klaimnya menentukan apa yang dapat dilakukan anggota tim di Console, dan keduanya tidak dievaluasi untuk permintaan kunci API. Lihat Peran & izin untuk matriks tersebut. Untuk mencegah layanan menghapus pengguna, berikan layanan itu kunci dengan akses People hanya baca, atau tanpa akses People sama sekali.

Batas laju dan idempotensi

Semua endpoint /v3/users/* tunduk pada batas laju standar.
create tidak idempoten. Mencoba ulang dengan vendor_data yang sama akan mengembalikan konflik. Lakukan deduplikasi di sisi Anda, atau selalu GET terlebih dahulu.
delete bersifat idempoten. Menghapus pengguna yang sudah dihapus tidak memberi efek apa pun.

Webhook yang dipicu oleh operasi ini

Operasi	Webhook
`create`	Tidak ada untuk panggilan create itu sendiri: `user.data.updated` pertama tiba saat sesi atau pembaruan pertama kali mengisi profil
`update`	`user.data.updated` (dengan `changed_fields`)
`update-status`	`user.status.updated`
`delete`	Tidak ada: catat penghapusan di sistem Anda sendiri jika Anda perlu bereaksi terhadapnya

Langkah selanjutnya

Model data

Referensi kolom lengkap.

API daftar

Skema GET /v3/users/.

API pembuatan

Skema POST /v3/users/create/.

Unggah wajah

Lampirkan gambar wajah yang diimpor ke profil pengguna.

Ikhtisar

Harga

Alur Kerja & Verifikasi

Peninjauan & Operasional

Entitas (Pengguna & Bisnis)

Pengaturan & Kustomisasi

Keamanan & Kepatuhan

Didit Academy

Sumber Daya

API Manajemen Pengguna: CRUD Pengguna Vendor Didit

Daftar pengguna

Ambil satu pengguna

Buat pengguna

Unggah wajah yang diimpor

Perbarui pengguna

Ubah status

Hapus pengguna (massal)

Model izin

Batas laju dan idempotensi

Webhook yang dipicu oleh operasi ini

Langkah selanjutnya

Model data

API daftar

API pembuatan

Unggah wajah

​Daftar pengguna

​Ambil satu pengguna

​Buat pengguna

​Unggah wajah yang diimpor

​Perbarui pengguna

​Ubah status

​Hapus pengguna (massal)

​Model izin

​Batas laju dan idempotensi

​Webhook yang dipicu oleh operasi ini

​Langkah selanjutnya

Model data

API daftar

API pembuatan

Unggah wajah

Daftar pengguna

Ambil satu pengguna

Buat pengguna

Unggah wajah yang diimpor

Perbarui pengguna

Ubah status

Hapus pengguna (massal)

Model izin

Batas laju dan idempotensi

Webhook yang dipicu oleh operasi ini

Langkah selanjutnya