Langsung ke konten utama
POST
curl
Menambahkan entri ke daftar. Nilainya divalidasi sesuai tipe entri daftar:
  • email: alamat email yang valid
  • phone: nomor telepon internasional yang valid, disimpan dalam format E.164 (misalnya +14155552671)
  • ip_address: alamat IP atau rentang CIDR yang valid (misalnya 192.168.1.1 atau 10.0.0.0/8)
  • device_fingerprint: minimal 8 karakter dari huruf, angka, -, _, : dan .. Daftar blokir menolak fingerprint yang dilaporkan oleh beberapa perangkat berbeda, karena memblokirnya akan menolak orang yang tidak terkait.
  • country: kode negara ISO 3166-1 alpha-3 yang valid (misalnya USA, GBR, ESP). Kode alpha-2 (misalnya US) diterima dan otomatis dikonversi ke alpha-3.
  • user, business: vendor_data dari pengguna atau bisnis
  • face, document, wallet_address, bank_account, key: string apa pun yang tidak kosong
Semua nilai entri tidak peka huruf besar/kecil. Nilai yang Anda kirim dinormalisasi saat disimpan (nomor telepon ke E.164, kode negara ke huruf besar, dan selain itu ke huruf kecil) dan dicocokkan tanpa memperhatikan huruf besar/kecil saat verifikasi. Misalnya, memblokir User@Example.COM juga akan menangkap user@example.com. Setiap nilai hanya boleh ada satu kali dalam daftar. Menambahkan nilai yang sudah ada dalam daftar akan mengembalikan 400.
Untuk wajah, gunakan Unggah wajah jika Anda hanya memiliki gambar, atau kirim reference_session_id untuk mengambil wajah dari sesi yang ada. Entri wajah memerlukan wajah tersimpan untuk dicocokkan, yang tidak disediakan oleh nilai value yang dikirim langsung.

Menambahkan dari sesi

Saat Anda menyediakan reference_session_id, Didit akan:
  1. Mencari sesi tersebut (sesi harus milik aplikasi yang sama)
  2. Membaca nilai dari catatan terbaru dengan tipe entri daftar tersebut:
    • face: wajah dari swafoto liveness; value adalah UUID wajah
    • document: nomor dokumen; nama lengkap, negara bagian penerbit, jenis dokumen, wilayah dan nomor dokumen disimpan dalam metadata, dan display_label secara default berisi nama pemegang dan nomor dokumen
    • phone: nomor telepon
    • email: alamat email
    • ip_address: alamat IP dari sesi
    • device_fingerprint: fingerprint yang mengidentifikasi satu perangkat, dengan mengutamakan perangkat yang telah menyelesaikan langkah verifikasi. Pada daftar blokir, Didit menolak sesi yang hanya memiliki fingerprint kelas perangkat, atau sesi yang diselesaikan di lebih dari satu perangkat: dalam kasus itu, kirim fingerprint yang tepat sebagai value.
  3. Menautkan entri ke sesi (reference_session_id) dan ke catatan (reference_object_uuid) untuk ketertelusuran
Pada daftar blokir sistem untuk wajah, dokumen, telepon dan email, catatan tersebut juga ditandai sebagai masuk daftar blokir, sehingga sesi baru yang cocok dengannya akan ditolak. Untuk tipe entri lainnya, kirim juga value. Mengembalikan 400 jika sesi tidak ditemukan atau tidak berisi data untuk tipe entri yang diminta.

Wajah dari swafoto pengambilan dokumen

Saat pengguna memotret dokumennya, kamera depan dapat mengambil swafoto mereka (gambar front_image_camera_front dan back_image_camera_front dari laporan verifikasi identitas). Wajah tersebut dapat ditambahkan ke daftar blokir wajah sekaligus wajah liveness: kirim face_image_source dengan gambar yang Anda inginkan.
  • Entri hanya dibuat di daftar blokir wajah sistem, dan value harus dikosongkan: Didit mengambil wajah dari swafoto sesi.
  • Swafoto harus berisi satu wajah yang jelas. Jika tidak, permintaan akan mengembalikan 400 dan tidak ada yang ditambahkan.
  • Setiap swafoto hanya dapat ditambahkan satu kali. metadata.face_image_source dan metadata.reference_node_id pada entri menunjukkan dari swafoto mana entri itu berasal.
  • Dalam alur kerja dengan lebih dari satu langkah verifikasi identitas, reference_node_id memilih langkah yang swafotonya akan digunakan. Secara default, Didit menggunakan verifikasi identitas terbaru yang memiliki swafoto tersebut.
  • Setelah itu, wajah diperiksa seperti wajah daftar blokir lainnya: terhadap swafoto liveness setiap sesi baru, dan terhadap setiap swafoto pengambilan dokumen baru (lihat FRONT_CAMERA_FACE_IN_BLOCKLIST).
  • Menghapus entri akan menghapus wajah dari daftar blokir, dan wajah tersebut berhenti dicocokkan dengan sesi baru.

Sesi dengan beberapa catatan dengan tipe yang sama

Sebuah sesi dapat memiliki lebih dari satu catatan dengan tipe tertentu, misalnya dua nomor telepon dari alur kerja multi-langkah. Didit selalu membaca catatan terbaru. Jika Anda mengirim value bersama reference_session_id, entri menyimpan value Anda tetapi tetap ditautkan ke catatan terbaru tersebut, dan pada daftar blokir sistem, catatan itulah yang ditandai. Untuk mendaftarkan nilai dari catatan sebelumnya, tambahkan dengan value saja, tanpa reference_session_id:

Merujuk transaksi, pengguna, dan bisnis

Saat memblokir data dari transaksi atau pengguna/bisnis vendor, kirim UUID entitas sebagai reference_object_uuid dan tunjukkan jenis sumbernya di metadata:
Ini memungkinkan Anda berpindah dari entri daftar blokir kembali ke transaksi, pengguna, atau bisnis asli di konsol. Didit menyimpan kunci metadata Anda, kecuali reference_image_url dan front_image_url, yang hanya diatur oleh Didit. Untuk entri yang dibaca dari sesi, Didit menambahkan kuncinya sendiri ke kunci Anda, dan kunci Didit yang berlaku. Pada daftar blokir sistem Pengguna dan Bisnis, Didit juga mengatur pengguna atau bisnis yang sesuai menjadi BLOCKED: yaitu yang vendor_data-nya sama dengan value, atau yang didit_internal_id-nya sama dengan reference_object_uuid. Lihat daftar blokir Pengguna dan daftar blokir Bisnis.

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

list_uuid
string<uuid>
wajib

UUID daftar yang akan ditambahkan. Untuk wajah yang hanya Anda miliki dalam bentuk gambar, gunakan Unggah wajah ke daftar sebagai gantinya.

Body

application/json

Kirim value, reference_session_id, atau keduanya. Kolom mana yang berlaku bergantung pada entry_type daftar tersebut.

value
string

Nilai yang akan dicantumkan dalam daftar, divalidasi terhadap entry_type daftar: email alamat email yang valid; phone nomor internasional yang valid, disimpan dalam E.164; ip_address alamat IP atau rentang CIDR (misalnya 10.0.0.0/8); device_fingerprint setidaknya 8 karakter di antara huruf, angka, -, _, :, dan . (daftar blokir menolak sidik jari yang dilaporkan oleh beberapa perangkat berbeda); country kode ISO 3166-1 alpha-2 atau alpha-3, disimpan sebagai alpha-3; user dan business berupa vendor_data; tipe lainnya berupa string yang tidak kosong. Disimpan dalam huruf kecil kecuali nomor telepon dan kode negara, dan daftar menyimpan setiap nilai satu kali (tidak peka huruf besar/kecil). Wajib diisi kecuali jika reference_session_id dikirim; harus dikosongkan jika face_image_source menggunakan pengambilan dokumen.

reference_session_id
string<uuid>

Sesi verifikasi perorangan atau bisnis pada aplikasi Anda yang akan menjadi sumber nilai. Didit membaca rekaman terbaru sesi dari tipe entri daftar tersebut (face, document, phone, email, ip_address or device_fingerprint), menautkan entri ke sesi dan ke rekaman tersebut, serta mengisi display_label dan metadata untuk dokumen. Untuk daftar blokir device_fingerprint, sesi yang hanya memiliki sidik jari kelas perangkat, atau diselesaikan di lebih dari satu perangkat, akan ditolak: kirimkan sidik jari yang tepat sebagai value. Untuk tipe entri lain, atau ketika sesi tidak memiliki rekaman tersebut, kirimkan juga value; value Anda kemudian disimpan dan entri tetap ditautkan ke sesi.

reference_object_uuid
string<uuid>

UUID rekaman yang diwakili entri ketika tidak berasal dari suatu sesi: UUID transaksi, atau didit_internal_id pengguna atau bisnis. Pasangkan dengan metadata.reference_type. Digantikan oleh rekaman sesi ketika reference_session_id menyediakannya.

face_image_source
enum<string>
default:liveness

Daftar wajah dengan reference_session_id: dari gambar sesi mana wajah diambil. liveness (default) adalah swafoto liveness. front_image_camera_front dan back_image_camera_front adalah swafoto yang diambil kamera depan saat pengguna memotret bagian depan atau belakang dokumen mereka: hanya diterima pada daftar blokir wajah sistem, dengan reference_session_id dan value kosong. Setiap swafoto dapat ditambahkan sekali dan harus menampilkan satu wajah yang jelas.

Opsi yang tersedia:
liveness,
front_image_camera_front,
back_image_camera_front
reference_node_id
string | null

Dengan face_image_source untuk pengambilan dokumen: node Verifikasi Identitas yang swafotonya akan digunakan, untuk alur kerja yang memiliki lebih dari satu. Secara default, gunakan Verifikasi Identitas terbaru yang memiliki gambar tersebut. Ditolak jika menggunakan liveness.

Maximum string length: 100
display_label
string

Label yang mudah dibaca manusia. Jika kosong, Didit menurunkannya dari sesi jika memungkinkan (misalnya nama pemegang dan nomor dokumen).

Maximum string length: 512
comment
string

Catatan teks bebas, seperti alasan pencantuman.

metadata
object

JSON bentuk bebas yang disimpan bersama entri dan dikembalikan sebagaimana disimpan. Gunakan reference_type dan reference_id agar konsol menautkan kembali ke sumbernya. reference_image_url dan front_image_url hanya diatur oleh Didit dan akan diabaikan jika Anda mengirimkannya. Untuk entri yang dibaca dari suatu sesi, kunci dari Didit digabungkan dengan kunci milik Anda.

Respons

Entri berhasil dibuat.

Satu nilai dalam sebuah daftar.

uuid
string<uuid>
wajib

Pengidentifikasi entri. Gunakan sebagai entry_uuid dalam operasi Hapus entri daftar.

value
string
wajib

Nilai yang terdaftar: nomor telepon dalam format E.164, alamat email, nomor dokumen, alamat IP atau rentang CIDR, sidik jari perangkat, alamat dompet, rekening bank, kode negara ISO 3166-1 alpha-3, vendor_data, string apa pun pada daftar key, atau UUID wajah yang disimpan pada daftar wajah. Nilai yang Anda kirim disimpan dalam huruf kecil, kecuali nomor telepon dan kode negara. Pencocokan tidak membedakan huruf besar dan kecil.

display_label
string | null
wajib

Label yang mudah dibaca manusia. Didit mengisinya untuk entri yang diambil dari sesi (misalnya nama pemegang dan nomor dokumen) saat Anda tidak mengirimkannya.

Maximum string length: 512
comment
string
wajib

Catatan teks bebas. String kosong jika tidak diatur.

added_by
string | null
wajib

Pihak yang menambahkan entri: api (kunci API), alamat email pengguna konsol atau console, system atau migration (entri yang dibuat Didit), atau rule (tindakan aturan transaksi atau aturan pemantauan).

reference_session_id
string<uuid> | null
wajib

Sesi verifikasi tempat entri tersebut diambil. null jika entri ditambahkan berdasarkan nilai.

reference_session_number
integer | null
wajib

Nomor sesi tersebut dalam cakupan aplikasi, seperti yang ditampilkan di konsol.

reference_session_type
enum<string> | null
wajib

kyc untuk sesi verifikasi perorangan, kyb untuk sesi verifikasi bisnis, null ketika tidak ada sesi.

Opsi yang tersedia:
kyc,
kyb,
null
reference_object_uuid
string<uuid> | null
wajib

Rekaman yang diwakili oleh entri: rekaman wajah, dokumen, telepon, atau email yang dibaca dari sesi, wajah yang dibuat melalui Unggah wajah ke daftar, atau UUID yang Anda kirim (misalnya UUID transaksi atau didit_internal_id milik pengguna).

metadata
object | null
wajib

Konteks tambahan. Berisi kunci yang ditetapkan Didit (tercantum di sini) yang digabungkan dengan metadata apa pun yang Anda kirimkan saat membuat entri, dikembalikan seperti yang disimpan. null jika tidak ada.

created_at
string<date-time>
wajib

Waktu ketika entri ditambahkan.

Terakhir diubah pada 7 November 2026