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
| Lingkungan | URL |
|---|---|
| Produksi | POST https://api.idcloud.unico.app/client/v1/process/{processId}/document |
| Sandbox | POST https://api.idcloud.uat.unico.app/client/v1/process/{processId}/document |
Permintaan
Header
| Header | Nilai |
|---|---|
Authorization | Bearer <access_token> (lihat Autentikasi) |
Content-Type | application/json |
Parameter path
| Field | Tipe | Diperlukan | Deskripsi |
|---|---|---|---|
processId | string | ya | ID proses yang dikembalikan di process.id saat pembuatan. |
Parameter body
| Field | Tipe | Diperlukan | Deskripsi |
|---|---|---|---|
duiType | enum | ya | Jenis 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. |
duiValue | string | ya | Nomor dokumen, tanpa pemformatan. Maksimum 320 karakter (mengakomodasi identifier yang dienkode atau komposit; nomor dokumen standar seperti CPF atau CURP jauh lebih pendek). |
Contoh
- cURL
- Node.js
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"
}'
import fetch from 'node-fetch';
const res = await fetch(
'https://api.idcloud.unico.app/client/v1/process/abc-123/document',
{
method: 'POST',
headers: {
'Authorization': `Bearer ${process.env.UNICO_ACCESS_TOKEN}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
duiType: 'DUI_TYPE_BR_CPF',
duiValue: '12345678901',
}),
}
);
const { process: proc } = await res.json();
// proc.id, proc.person.duiType, proc.person.duiValue
Respons
200 OK
{
"process": {
"id": "abc-123",
"person": {
"duiType": "DUI_TYPE_BR_CPF",
"duiValue": "12345678901"
}
}
}
| Field | Tipe | Deskripsi |
|---|---|---|
process.id | string | Pengidentifikasi proses. |
process.person.duiType | string | Jenis dokumen yang ditetapkan pada proses. |
process.person.duiValue | string | Nilai 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
- 400 Bad Request
- 401 Unauthorized
- 404 Not Found
- 429 Too Many Requests
- 500 Internal Server Error
| Kode | Pesan | Deskripsi |
|---|---|---|
3 | process id is invalid | Ketika ID proses tidak valid. |
3 | dui_type is required | Ketika jenis dokumen tidak disediakan. |
3 | dui_value is required | Ketika nomor dokumen tidak disediakan. |
3 | dui_value exceeds maximum length | Ketika nomor dokumen melebihi batas karakter maksimum. |
9 | process is not awaiting for document | Ketika proses yang ditentukan tidak menerima pengiriman dokumen. |
9 | process expired | Ketika proses yang ditentukan telah kedaluwarsa. |
9 | document already set, cannot be modified | Ketika proses sudah memiliki dokumen yang tertaut. |
9 | process already finished | Ketika proses sudah selesai. |
9 | flow does not allow optional document | Ketika dokumen bersifat wajib untuk flow yang dijalankan oleh proses. |
| Pesan | Deskripsi |
|---|---|
| Jwt header is an invalid JSON | Ketika token akses yang digunakan mengandung karakter yang tidak benar. |
| Jwt is expired | Ketika token akses yang digunakan telah kedaluwarsa. |
| Kode | Pesan | Deskripsi |
|---|---|---|
5 | error getting process: rpc error: code = NotFound desc = process not found | Ketika ID proses tidak ditemukan. |
Tidak ada kode error terperinci yang diberikan untuk status ini — hanya kode status HTTP.
| Kode | Pesan | Deskripsi |
|---|---|---|
99999 | Internal failure! Try again later | Ketika terjadi error internal. |
Langkah selanjutnya
- Setelah menetapkan dokumen, proses melanjutkan pipeline-nya. Panggil Get Process untuk mengambil hasilnya, atau tunggu webhook.