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.

Body

multipart/form-data
user_image
file
wajib

Gambar wajah nyata atau kandidat yang akan diverifikasi (misalnya swafoto). Kirim satu foto menghadap ke depan dengan wajah subjek terlihat jelas dan pencahayaan baik. Ekstensi yang diizinkan: tiff, jpg, jpeg, png, webp. Ukuran unggahan maksimum: 5 MB (file yang lebih besar ditolak dengan 400). Gambar secara otomatis dikompresi menjadi ~0.5 MB sebelum diproses, sehingga resolusi yang sangat tinggi tidak meningkatkan akurasi.

ref_image
file
wajib

Gambar wajah referensi untuk dibandingkan (misalnya foto dokumen identitas atau foto yang didaftarkan sebelumnya). Format dan batas ukuran sama seperti user_image.

face_match_score_decline_threshold
number<float>
default:30

Ambang batas kemiripan (0–100) yang menentukan respons status. Skor terhitung pada atau di bawah nilai ini akan menetapkan status menjadi Declined dan menambahkan peringatan LOW_FACE_MATCH_SIMILARITY; skor yang secara ketat berada di atasnya mengembalikan Approved. Nilai default 30 bersifat permisif — naikkan nilainya (misalnya 50–60) untuk verifikasi yang lebih ketat. Nilai di luar 0–100 mengembalikan 400.

Rentang yang diperlukan: 0 <= x <= 100
Contoh:

50

rotate_image
boolean
default:false

Jika true, layanan mencoba gambar-gambar input dalam kelipatan 90 derajat (0, 90, 180, 270) dan menggunakan orientasi yang menghasilkan deteksi wajah terbaik — berguna untuk pengambilan gambar seluler dengan orientasi EXIF yang hilang. Menambah latensi, jadi aktifkan hanya jika Anda tidak dapat menjamin gambar dalam posisi tegak.

Contoh:

false

save_api_request
boolean
default:true

Jika true (default), menyimpan panggilan sebagai sesi tipe API — terlihat di Business Console, dapat diambil melalui GET /v3/session/{sessionId}/decision/ menggunakan request_id yang dikembalikan, dan diumumkan melalui webhook status.updated. Jika false, tidak ada yang disimpan dan request_id adalah UUID sementara hanya untuk korelasi respons.

Contoh:

true

vendor_data
string

String buram opsional (ID pengguna internal, email, UUID Anda…) yang disimpan pada sesi yang dipertahankan dan dikembalikan dalam respons. Gunakan untuk mengorelasikan panggilan API dengan catatan Anda sendiri dan memfilter sesi nantinya.

Contoh:

"user-123"

metadata
object

Objek JSON opsional yang disimpan bersama sesi (saat save_api_request=true) dan dikembalikan dalam respons. Dalam permintaan multipart, kirimkan sebagai kolom string yang dikodekan dalam JSON (misalnya metadata={"flow":"login"}) — kolom ini akan diuraikan menjadi sebuah objek.

Contoh:

Respons

Pencocokan wajah telah dihitung. face_match.score adalah float 0–100 (dua desimal); status adalah Approved ketika skor secara ketat di atas face_match_score_decline_threshold, jika tidak Declined dengan peringatan penjelas. Pasangan dengan kemiripan rendah atau tidak dapat dinilai tetap mengembalikan 200 — periksa face_match.status dan face_match.warnings, bukan hanya kode HTTP. Ketika save_api_request=true, request_id adalah id sesi yang disimpan.

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.

face_match
object
vendor_data
string | null

Salinan vendor_data yang Anda kirimkan, atau null.

metadata
object | null

Salinan objek metadata yang Anda kirimkan, atau null.

created_at
string<date-time>

Stempel waktu ISO 8601 (UTC) saat respons dibuat, misalnya 2026-06-12T01:04:42.763237+00:00.

Terakhir diubah pada 7 November 2026