Lewati ke konten utama

Buat Proses

Endpoint ini menangani dua kasus penggunaan yang berbagi path yang sama tetapi berbeda dalam parameter body, kemampuan, dan field respons:

  • Integrasi — memvalidasi siapa pengguna dengan membandingkan wajah mereka terhadap basis identitas Unico (subject.code diperlukan).
  • Transaksional — memverifikasi bahwa ini adalah orang yang sama dari proses sebelumnya dengan membandingkan wajah-ke-wajah (referenceProcessId ATAU array references dengan selfie / process id diperlukan).

Kasus penggunaan aktif ditentukan oleh APIKEY yang dikirim di header permintaan.

Untuk alur integrasi lengkap, lihat Ikhtisar API.

Endpoint

LingkunganURL
ProduksiPOST https://api.id.unico.app/processes/v1
SandboxPOST https://api.id.uat.unico.app/processes/v1

Permintaan

Headers
HeaderNilai
AuthorizationBearer <access_token> (lihat Autentikasi)
APIKEYKunci API yang disediakan — mendefinisikan kasus penggunaan aktif dan kemampuan yang diaktifkan.
Content-Typeapplication/json
Parameter body
FieldTipeWajibDeskripsi
subject.codestringyaCPF (BR) atau CURP (MX).
subject.namestringyaNama lengkap.
subject.genderstringtidakM atau F.
subject.birthDatestring (ISO 8601)tidakTanggal lahir (YYYY-MM-DD).
subject.emailstringtidakAlamat email.
subject.phonestringtidakNomor telepon E.164.
useCasestringtidakKonteks operasi, mis. Onboarding.
imageBase64stringyaSelfie yang diambil oleh front-end Anda, dalam base64.
Persyaratan gambar
  • Resolusi minimum: 640 × 480 (standar HD)
  • Ukuran file maksimum: 800 KB (disarankan kompresi JPEG92)
  • Format yang diterima: PNG, JPEG, WebP
  • Token JWT dari SDK kedaluwarsa setelah 10 menit dan hanya dapat digunakan satu kali

Contoh

curl -X POST https://api.id.unico.app/processes/v1 \
-H "Authorization: Bearer $TOKEN" \
-H "APIKEY: $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"subject": {
"code": "12345678909",
"name": "Luke Skywalker",
"gender": "M",
"birthDate": "2000-05-20",
"email": "[email protected]",
"phone": "5519725570707"
},
"useCase": "Onboarding",
"imageBase64": "/9j/4AAQSkZJR..."
}'

Respons

200 OK
{
"id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
"status": 3,
"unicoId": { "result": "yes" },
"identityFraudsters": { "result": "inconclusive" },
"government": { "serpro": 87 },
"liveness": 1
}
FieldTipeDeskripsi
idstring (UUID)Pengidentifikasi proses. Gunakan dengan Dapatkan Proses untuk kueri ulang.
statusinteger1 (memproses), 3 (selesai dengan sukses), 5 (error). Untuk semua nilai yang mungkin, lihat Dapatkan Proses.
unicoId.resultstringyes, no, inconclusive — lihat Verifikasi Identitas.
identityFraudsters.resultstringyes, inconclusive — lihat Klasifikasi risiko penipuan.
government.serprointegerSkor kesamaan Serpro (0–100, -1, -2). Lihat Hasil Kemiripan Serpro.
livenessinteger1 (lulus), 2 (gagal) — lihat Deteksi Kehidupan.
informasi

Ketika unicoId.result = inconclusive dan orkestrasi Klasifikasi risiko penipuan aktif, proses mungkin mengembalikan status: 1 (memproses). Poll Dapatkan Proses atau gunakan webhook untuk mengambil hasil akhir.

400 Bad Request

Payload tidak sesuai format, gambar tidak valid, atau field yang diperlukan tidak ada. Lihat Kode Error di bawah.

403 Forbidden

Bearer token atau APIKEY tidak ada, kedaluwarsa, atau tidak valid. Lihat Autentikasi.

409 Conflict

processId yang diberikan sudah ada untuk tenant ini. Lihat Kode Error di bawah.

429 Too Many Requests

Batas rate limit tercapai. Coba lagi setelah interval yang ditunjukkan di header respons Retry-After. Lihat Rate limits.

Kode Error

KodePesanDeskripsi
20900O base64 informado não é válido.Parameter base64 tidak valid. Kemungkinan penyebab: bukan gambar atau percobaan injeksi.
20807A imagem precisa estar no padrão HD ou possuir uma resolução superior a 640 x 480.Resolusi gambar yang diunggah terlalu rendah.
20513The referenced process was not found.referenceProcessId mengarah ke proses yang tidak ada atau tidak lagi dapat diakses.
20512The referenced process is not available for reuse.Proses yang direferensikan ada tetapi tidak tersedia untuk digunakan ulang.
20509The subject.name field is invalid.subject.name mengandung karakter tidak valid.
20508The subject.gender field is invalid.subject.gender harus M atau F.
20507O parâmetro subject.code é inválido.CPF tidak standar atau tidak ada.
20506O base64 informado é muito grande. O tamanho máximo suportado é até 800kb.Ukuran gambar melebihi 800 KB; kompres ke JPEG92.
20505O base64 informado não é suportado. Os formatos aceitos são png, jpeg e webp.Format base64 tidak valid atau tidak didukung.
20065The referenceProcessId field is invalid.referenceProcessId bukan UUID yang valid.
20062The useCase field is invalid.Nilai tidak dikenal di field useCase.
20024The referenceProcessId field is missing.Parameter referenceProcessId tidak disediakan dan references tidak dikirim sebagai alternatif.
20021The subject.phone field is invalid.Format subject.phone tidak valid (IDD + kode area + nomor, 13 karakter).
20019The subject.birthDate field is invalid.subject.birthDate berada di luar format ISO 8601 (YYYY-MM-DD).
20009O parâmetro imagebase64 não foi informado.Parameter gambar selfie tidak ada.
20008The subject.email field is invalid.Format email tidak valid di subject.email.
20006O parâmetro subject.name não foi informado.Parameter subject.name tidak ada.
20005O parâmetro subject.code não foi informado.Parameter subject.code tidak ada.
20004O parâmetro subject não foi informado.Parameter subject tidak ada.
20003The request body is missing or invalid.Payload null atau tidak valid.
20002O parâmetro APIKey não foi informado.Parameter APIKEY tidak ada dari header permintaan.
20001O parâmetro authtoken não foi informado.Parameter token integrasi tidak ada dari header permintaan.
10508The JWT with the captured face has already been used.JWT hanya dapat digunakan sekali.
10507The JWT with the captured face is expired.JWT kedaluwarsa; harus dikirim dalam 10 menit.
10506The imageBase64 field is not a valid JWT from SDK.imageBase64 bukan JWT valid yang dihasilkan oleh SDK.

Langkah selanjutnya

  • Untuk mengkueri hasil proses Integrasi, lihat Dapatkan Proses.
  • Untuk operasi Dokumen dan Verifikasi Usia, lihat halaman masing-masing di bagian ini.