Lewati ke konten utama

Set Dokumen Proses

Menetapkan dokumen identifikasi (CPF, CURP, SSN, atau duiType lainnya) pada proses yang dibuat tanpa dokumen. Setelah ditetapkan, dokumen tidak dapat diubah.

Hanya tersedia untuk proses yang Custom Flow-nya mengizinkan pembuatan tanpa dokumen — yaitu, proses dalam status AWAITING_FOR_DOCUMENT.

Endpoint

LingkunganURL
ProduksiPOST https://api.idcloud.unico.app/client/v1/process/{processId}/document
SandboxPOST https://api.idcloud.uat.unico.app/client/v1/process/{processId}/document

Permintaan

Header
HeaderNilai
AuthorizationBearer <access_token> (lihat Autentikasi)
Content-Typeapplication/json
Parameter path
FieldTipeDiperlukanDeskripsi
processIdstringyaID proses yang dikembalikan di process.id saat pembuatan.
Parameter body
FieldTipeDiperlukanDeskripsi
duiTypeenumyaJenis dokumen. Nilai: DUI_TYPE_BR_CPF, DUI_TYPE_MX_CURP, DUI_TYPE_US_SSN. Endpoint ini mendukung sebagian dari jenis dokumen yang diterima oleh Create Process — Custom Flow yang mengizinkan pembuatan dokumen opsional saat ini divalidasi terhadap daftar yang lebih terbatas ini.
duiValuestringyaNomor dokumen, tanpa pemformatan. Maksimum 320 karakter (mengakomodasi identifier yang dienkode atau komposit; nomor dokumen standar seperti CPF atau CURP jauh lebih pendek).

Contoh

curl -X POST https://api.idcloud.unico.app/client/v1/process/abc-123/document \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"duiType": "DUI_TYPE_BR_CPF",
"duiValue": "12345678901"
}'

Respons

200 OK
{
"process": {
"id": "abc-123",
"person": {
"duiType": "DUI_TYPE_BR_CPF",
"duiValue": "12345678901"
}
}
}
FieldTipeDeskripsi
process.idstringPengidentifikasi proses.
process.person.duiTypestringJenis dokumen yang ditetapkan pada proses.
process.person.duiValuestringNilai dokumen yang ditetapkan pada proses.
400 Bad Request

Dikembalikan ketika payload permintaan tidak valid, field yang diperlukan tidak ada, atau status proses tidak mengizinkan operasi.

401 Unauthorized

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

404 Not Found

Proses tidak ditemukan.

429 Too Many Requests

Batas rate tercapai. Tidak ada kode error terperinci yang diberikan — hanya status HTTP.

Kode Error

KodePesanDeskripsi
3process id is invalidKetika ID proses tidak valid.
3dui_type is requiredKetika jenis dokumen tidak disediakan.
3dui_value is requiredKetika nomor dokumen tidak disediakan.
3dui_value exceeds maximum lengthKetika nomor dokumen melebihi batas karakter maksimum.
9process is not awaiting for documentKetika proses yang ditentukan tidak menerima pengiriman dokumen.
9process expiredKetika proses yang ditentukan telah kedaluwarsa.
9document already set, cannot be modifiedKetika proses sudah memiliki dokumen yang tertaut.
9process already finishedKetika proses sudah selesai.
9flow does not allow optional documentKetika dokumen bersifat wajib untuk flow yang dijalankan oleh proses.

Langkah selanjutnya

  • Setelah menetapkan dokumen, proses melanjutkan pipeline-nya. Panggil Get Process untuk mengambil hasilnya, atau tunggu webhook.