Langsung ke konten utama
POST
curl

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.

Header

Idempotency-Key
string

Kunci keamanan percobaan ulang opsional, hingga 255 karakter. Menggunakan kembali kunci yang sama dengan body permintaan yang sama akan mengembalikan respons asli tanpa menjalankan atau menagih biaya untuk skrining kedua. Menggunakan kembali kunci dengan body yang berbeda akan mengembalikan 409.

Maximum string length: 255

Body

application/json
full_name
string
wajib

Nama lengkap individu atau perusahaan yang akan diskrining. Minimum 2 karakter - batas minimum dari penyedia skrining itu sendiri. Nama yang lebih pendek atau kosong akan mengembalikan 400 pada kolom ini sebelum skrining apa pun dijalankan, sehingga tidak ada yang ditagihkan.

Minimum string length: 2
Contoh:

"Antonio Ejemplo Modelo"

entity_type
enum<string>
default:person

Jenis entitas yang akan diskrining. Secara default adalah person.

Opsi yang tersedia:
person,
company
date_of_birth
string<date>

Tanggal lahir (perorangan) atau tanggal pendirian (perusahaan), YYYY-MM-DD. Meningkatkan presisi kecocokan melalui bobot DOB.

Contoh:

"1972-02-29"

nationality
string

Kode negara ISO 3166-1 alpha-2 (misalnya ES). Kode tidak valid mengembalikan 400. Meningkatkan presisi pencocokan melalui bobot negara.

Contoh:

"ES"

document_number
string

Nomor dokumen identitas. Tidak diberi bobot — bertindak sebagai kunci emas: kecocokan persis akan menimpa match_score hasil pencarian menjadi 100, sedangkan ketidakcocokan total akan memotong skornya. Dikirim ke penyedia skrining sebagai filter pencarian hanya jika berukuran 2-50 karakter; nilai di luar rentang tersebut diterima dan disimpan, dan skrining tetap berjalan serta ditagih, hanya saja tidak dipersempit berdasarkan nomor dokumen.

aml_score_approve_threshold
number
default:80

Ambang batas skor risiko yang pada atau di bawahnya menghasilkan Approved. Harus ≤ aml_score_review_threshold (jika tidak, 400).

Rentang yang diperlukan: 0 <= x <= 100
aml_score_review_threshold
number
default:100

Ambang batas skor risiko yang jika dilampaui menghasilkan Declined. Skor di antara kedua ambang batas menghasilkan In Review.

Rentang yang diperlukan: 0 <= x <= 100
aml_name_weight
integer
default:60

Bobot kemiripan nama dalam skor kecocokan per entri yang cocok. Ketiga bobot harus berjumlah tepat 100 (jika tidak, 400).

Rentang yang diperlukan: 0 <= x <= 100
aml_dob_weight
integer
default:25

Bobot tanggal lahir dalam skor kecocokan per entri yang cocok.

Rentang yang diperlukan: 0 <= x <= 100
aml_country_weight
integer
default:15

Bobot negara/kewarganegaraan dalam skor kecocokan per entri yang cocok.

Rentang yang diperlukan: 0 <= x <= 100
aml_match_score_threshold
integer
default:93

Batas per hit: hit dengan match_score di bawah nilai ini dianggap False Positive (dikecualikan dari penilaian risiko); nilai yang sama atau di atasnya dianggap kecocokan potensial Unreviewed.

Rentang yang diperlukan: 0 <= x <= 100
include_adverse_media
boolean
default:false

Cari juga media berita untuk liputan negatif. Menambah latensi hingga ~30 dtk saat hasil dikumpulkan — gunakan batas waktu klien ≥60 dtk.

include_ongoing_monitoring
boolean
default:false

Tetap lakukan skrining ulang profil ini dan kirimkan perubahan melalui webhook. Memerlukan save_api_request=true (jika tidak, 400).

save_api_request
boolean
default:true

Simpan skrining sebagai sesi (visibilitas konsol, endpoint keputusan, webhook, peninjauan hit). Atur ke false untuk pemeriksaan tanpa status.

vendor_data
string

Pengenal Anda untuk pengguna yang diskrining; dikembalikan dan disimpan bersama sesi.

metadata
object | null

JSON bentuk bebas yang disimpan bersama permintaan dan dikembalikan dalam respons.

sandbox_scenario
string

Slug skenario khusus sandbox. Hanya diterima jika kunci API milik aplikasi mode sandbox; ditolak pada aplikasi di lingkungan produksi. Skrining mandiri tidak memiliki sesi untuk dipicu, jadi slug diletakkan langsung pada permintaan skrining: decline_aml_hit mengembalikan satu kecocokan berformat produksi dan menetapkan skrining sebagai Declined, review_aml_possible_match menetapkannya sebagai In Review, dan skenario yang tidak menetapkan hasil AML akan membiarkan skrining bersih. Lihat katalog skenario di GET /v1/sandbox/scenarios/ atau Sandbox & Test Data.

Contoh:

"decline_aml_hit"

Respons

Skrining selesai. aml.status mencerminkan ambang batas Anda; setiap temuan pada atau di atas batas minimum inklusi internal tercantum dalam aml.hits dengan match_score untuk identitas, risk_score untuk entitas, dan score_breakdown yang menjelaskan kecocokan tersebut.

request_id
string<uuid>

ID sesi yang disimpan saat save_api_request=true (dapat digunakan dengan GET /v3/session/{sessionId}/decision/); jika tidak, berupa UUID korelasi sementara.

aml
object
vendor_data
string | null

Menampilkan kembali vendor_data yang Anda kirimkan.

metadata
object | null

Salinan metadata yang Anda kirimkan.

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