Lewati ke konten utama

Buat Proses Dokumen

Endpoint ini menangani dua alur dokumen yang berbagi path yang sama tetapi berbeda dalam parameter body:

  • Pengambilan baru — mengirimkan gambar dokumen dalam base64 untuk diproses (field document.files diperlukan).
  • Penggunaan ulang — melewati pengambilan gambar dengan merujuk dokumen yang sebelumnya diambil (field document.documentId diperlukan).

Alur yang aktif ditentukan oleh apakah document.documentId diberikan dalam body permintaan.

Sebelum membuat proses dokumen, gunakan Dapatkan Dokumen yang Dapat Digunakan Ulang untuk memeriksa apakah pengguna sudah memiliki dokumen yang tersedia untuk digunakan ulang.

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 telah ditetapkan dengan Document Capture and Reuse diaktifkan.
Content-Typeapplication/json
Parameter body
FieldTipeWajibDeskripsi
subject.duiTypestringyaTipe pengidentifikasi. Nilai yang mungkin: DUI_TYPE_BR_CPF, DUI_TYPE_MX_CURP, DUI_TYPE_US_SSN, DUI_TYPE_NG_NIN, DUI_TYPE_AR_DNI, DUI_TYPE_ID_NIK.
subject.codestringyaNilai pengidentifikasi pengguna sesuai yang didefinisikan oleh subject.duiType. Tanpa titik atau tanda hubung.
subject.namestringtidakNama lengkap.
subject.genderstringtidakM atau F.
subject.birthDatestring (ISO 8601)tidakTanggal lahir (YYYY-MM-DD).
subject.emailstringtidakAlamat email.
subject.phonestringtidakNomor telepon E.164.
document.purposestringyaTujuan bisnis. Nilai: creditprocess, carpurchase, paybypaycheck, onboarding, fgts.
document.authProcessIdstringyaID proses biometrik yang terhubung ke pengambilan dokumen ini.
document.filesarrayyaGambar dokumen dalam base64 (depan dan/atau belakang).
document.files[].datastringyaGambar dokumen dalam base64 (PNG, JPEG, atau WebP, maks 800 KB).
subsidiaryIdstringtidakID cabang — hanya diperlukan jika terdapat beberapa cabang.

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": {
"duiType": "DUI_TYPE_BR_CPF",
"code": "12345678909",
"name": "Luke Skywalker"
},
"document": {
"purpose": "onboarding",
"authProcessId": "80371b2a-3ac7-432e-866d-57fe37896ac6",
"files": [
{ "data": "/9j/4AAQSkZJR..." }
]
}
}'

Respons

200 OK
{
"id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
"status": 3,
"document": {
"id": "doc-abc-123",
"type": "unico.moja.dictionary.br.cnh.v2.Cnh",
"cpfMatch": true,
"faceMatch": true,
"content": {
"numero": "12345678",
"nomeCivil": "Luke Skywalker",
"dataNascimento": "2000-05-20T00:00:00Z",
"categoria": "B",
"dataExpiracao": "2030-05-20T00:00:00Z"
},
"fileUrls": [
"https://storage.unico.app/documents/doc-abc-123/front.jpg"
]
}
}
FieldTipeDeskripsi
idstring (UUID)Pengidentifikasi proses.
statusinteger3 (selesai dengan sukses), 5 (selesai dengan kegagalan).
document.idstringPengidentifikasi dokumen yang diambil. Gunakan nilai ini dalam permintaan document.documentId di masa mendatang untuk penggunaan ulang.
document.typestringTipe dokumen yang diidentifikasi. Nilai yang mungkin: unico.moja.dictionary.br.rg.v2.Rg, unico.moja.dictionary.br.cnh.v2.Cnh, unico.moja.dictionary.br.cin.v1.Cin, unico.moja.dictionary.br.passaporte.v1.Passaporte.
document.cpfMatchbooleantrue jika pengidentifikasi yang diekstrak dari dokumen cocok dengan subject.code.
document.faceMatchbooleantrue jika wajah pada dokumen cocok dengan foto selfie biometrik dari document.authProcessId.
document.contentobjectField yang diekstrak melalui OCR. Struktur bervariasi berdasarkan tipe dokumen — lihat di bawah.
document.fileUrlsarrayURL sementara (validitas 10 menit) untuk mengunduh gambar dokumen.
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.

Kode Error

KodePesanDeskripsi
99989The document is invalid.Objek document memiliki struktur tidak valid.
99988The document is empty.Objek document tidak ada dalam body permintaan.
20900O base64 informado não é válido.Parameter base64 tidak valid. Kemungkinan penyebab: bukan gambar atau merupakan 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.
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.Nilai pengidentifikasi 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.
20068The document.documentId or document.files parameter must be present.document.documentId maupun document.files tidak disediakan.
20067The document.purpose parameter is invalid.Nilai tidak dikenal di document.purpose.
20066The document.authProcessId parameter is invalid.Nilai tidak valid di document.authProcessId.
20062The useCase field is invalid.Nilai tidak dikenal di field useCase.
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 dokumen tidak ada.
20008The subject.email field is invalid.Format email tidak valid di subject.email.
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