Dapatkan Dokumen yang Dapat Digunakan Ulang

Gunakan endpoint ini untuk memeriksa apakah pengguna sudah memiliki dokumen yang tersedia untuk digunakan ulang sebelum memulai alur pengambilan Dokumen baru. Jika dokumen ditemukan, documentId-nya dapat langsung diteruskan ke POST /processes/v1 (tipe Dokumen) untuk melewati langkah pengambilan.

Endpoint

Lingkungan	URL
Produksi	GET https://api.id.unico.app/documents/v1
Sandbox	GET https://api.id.uat.unico.app/documents/v1

Permintaan

Headers

Header	Nilai
Authorization	Bearer <access_token> (lihat Autentikasi)
APIKEY	API key yang disediakan dengan Document Capture and Reuse diaktifkan.

Parameter query

Parameter	Tipe	Wajib	Deskripsi
code	string	ya	Pengenal pengguna (CPF atau CURP, tanpa pemformatan).
type	string	ya	Tipe dokumen yang akan dikueri. Nilai yang diterima: BR_RG, BR_CNH, BR_CIN, BR_PASSPORT.

catatan

Nilai type di atas khusus untuk endpoint ini. Jangan dikacaukan dengan:

• subject.duiType dalam permintaan POST — menggunakan awalan DUI_TYPE_* dan mengidentifikasi orang, bukan tipe dokumen (misalnya, DUI_TYPE_BR_CPF).
• documentType dalam respons — menggunakan jalur registri lengkap (misalnya, unico.moja.dictionary.br.cnh.v2.Cnh).

Contoh

cURL

curl -X GET "https://api.id.unico.app/documents/v1?code=12345678909&type=BR_CNH" \
  -H "Authorization: Bearer $TOKEN" \
  -H "APIKEY: $API_KEY"

Node.js

import fetch from 'node-fetch';

const params = new URLSearchParams({ code: '12345678909', type: 'BR_CNH' });
const res = await fetch(
  `https://api.id.unico.app/documents/v1?${params}`,
  {
    headers: {
      Authorization: `Bearer ${accessToken}`,
      APIKEY: apiKey
    }
  }
);
const data = await res.json();
// data.items[0].documentId → pass to POST /processes/v1 for reuse

Respons

200 OK

{
  "items": [
    {
      "documentType": "unico.moja.dictionary.br.cnh.v2.Cnh",
      "documentId": "doc-abc-123"
    }
  ]
}

Field	Tipe	Deskripsi
items	array	Daftar dokumen yang dapat digunakan ulang yang ditemukan untuk pengguna. Array kosong jika tidak ada dokumen yang dapat digunakan ulang ditemukan untuk code dan type yang diberikan.
items[].documentType	string	Pengenal tipe dokumen. 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.
items[].documentId	string	Pengenal dokumen. Teruskan nilai ini di document.documentId pada POST /processes/v1 untuk menggunakan ulang dokumen.

403 Forbidden

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

429 Too Many Requests

Batas permintaan tercapai. Coba lagi setelah interval yang ditunjukkan di header respons Retry-After. Lihat Batas permintaan.

Menggunakan documentId untuk penggunaan ulang

Setelah Anda memiliki documentId, teruskan dalam permintaan proses Dokumen untuk melewati pengambilan:

{
  "subject": {
    "code": "12345678909",
    "name": "Luke Skywalker"
  },
  "document": {
    "purpose": "onboarding",
    "authProcessId": "<biometric-process-id>",
    "documentId": "doc-abc-123"
  }
}

Field	Deskripsi
document.purpose	Tujuan bisnis untuk proses dokumen ini. Nilai yang diterima: creditprocess, carpurchase, paybypaycheck, onboarding, fgts. Nilai-nilai ini khusus untuk Document API dan berbeda dari enum purpose SDK biometrik.
document.authProcessId	ID proses biometrik yang sebelumnya dibuat untuk pengguna ini (dari POST /processes/v1).
document.documentId	ID dokumen yang diperoleh dari respons endpoint ini. Jika disediakan, document.files dapat dihilangkan — platform mengambil dokumen yang sebelumnya diambil secara otomatis.

Untuk skema permintaan proses Dokumen lengkap, lihat Buat Proses Dokumen.

Kode Error

400 Bad Request

Kode	Pesan	Deskripsi
20507	O parâmetro subject.code é inválido.	Nilai pengenal yang salah format atau tidak ada (CPF atau CURP).
20002	O parâmetro APIKey não foi informado.	Header APIKEY tidak ada.
20001	O parâmetro authtoken não foi informado.	Header token autentikasi tidak ada.

403 Forbidden

Kode	Pesan	Deskripsi
30017	Jwt header is an invalid JSON.	Access-token mengandung karakter yang tidak valid.
10502	O token informado está expirado.	Access-token kedaluwarsa.
10501	O token informado é inválido.	Token autentikasi tidak valid.
10201	O AppKey informado é inválido.	APIKEY tidak ada atau tidak ditemukan.

404 Not Found

Kode	Pesan	Deskripsi
99987	Attachment not found.	Lampiran yang terkait dengan dokumen tidak ditemukan.
50001	The process is not found.	Tidak ada dokumen yang ditemukan untuk parameter yang diberikan.

500 Internal Server Error

Kode	Pesan	Deskripsi
99999	Internal failure! Try again later.	Kesalahan pemrosesan di sisi server.