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 menghadap ke depan yang digunakan untuk pencarian. Ekstensi yang diizinkan: tiff, jpg, jpeg, png, webp. Ukuran unggah maksimum: 5 MB (berkas yang lebih besar ditolak dengan kode 400). Gambar dikompresi secara otomatis menjadi ~0.5 MB sebelum diproses, sehingga resolusi yang sangat tinggi tidak meningkatkan akurasi. Gambar harus berisi setidaknya satu wajah yang dapat dideteksi — jika tidak, endpoint akan mengembalikan kode 400. Jika terdapat beberapa wajah, wajah terbesar yang akan dicari dan peringatan MULTIPLE_FACES_DETECTED akan ditambahkan.

search_type
enum<string>
default:most_similar

Kebijakan pencarian. most_similar (default) mengurutkan setiap wajah yang terdaftar di aplikasi Anda berdasarkan kemiripan. blocklisted_or_approved membatasi kandidat ke wajah yang masuk daftar blokir, wajah yang masuk daftar izin, wajah dari sesi yang disetujui, dan wajah profil pengguna yang diimpor — dengan entri daftar blokir diurutkan terlebih dahulu.

Opsi yang tersedia:
most_similar,
blocklisted_or_approved
Contoh:

"most_similar"

rotate_image
boolean
default:false

Jika true, layanan mencoba rotasi 90 derajat dari input dan menggunakan orientasi yang menghasilkan deteksi wajah terbaik. Berguna saat orientasi EXIF tidak ada. Menambah latensi.

Contoh:

false

save_api_request
boolean
default:true

Jika true (default), menyimpan panggilan sebagai sesi tipe API, memancarkan webhook status.updated, melakukan pra-penandatanganan nilai match_image_url, dan mendaftarkan wajah yang dicari ke dalam indeks pencarian wajah Anda (pendaftaran Pencarian Wajah dikecualikan dari pencarian mendatang). Jika false, pencarian bersifat sekali jalan — tidak ada sesi yang disimpan dan wajah tidak didaftarkan.

Contoh:

true

vendor_data
string

Pengidentifikasi buram opsional (ID pengguna, email, UUID Anda…) yang disimpan pada sesi yang dipertahankan dan dikembalikan. Kolom ini tidak mengecualikan wajah pengguna yang sama dari hasil pencarian.

Contoh:

"user-123"

metadata
object

Objek JSON opsional yang disimpan bersama sesi (saat save_api_request=true) dan dikembalikan. Dalam permintaan multipart, kirimkan sebagai kolom string berenkode JSON — kolom ini akan diuraikan menjadi sebuah objek.

Contoh:

Respons

Pencarian wajah selesai. face_search.matches memuat hingga 5 wajah serupa yang diurutkan berdasarkan kemiripan; array kosong berarti tidak ada wajah terdaftar yang melampaui batas minimum kemiripan. status bernilai Declined hanya pada kecocokan daftar blokir — kecocokan duplikat saja mengembalikan Approved, jadi periksa matches dan warnings, bukan hanya status. Ketika save_api_request=true, request_id adalah id sesi yang disimpan. Setiap kecocokan membawa source (session, imported, list_entry, atau retained_template), vendor_user_id, dan biometric_template_id; kecocokan retained_template berasal dari templat biometrik bebas gambar yang disimpan setelah sesi sumber dihapus dan memiliki kolom sesi null, match_image_url, dan user_details.

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.

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