Получение документов для повторного использования
Используйте этот эндпоинт, чтобы проверить, есть ли у пользователя уже документ, доступный для повторного использования, прежде чем начинать новый поток захвата документа. Если документ найден, его documentId можно передать напрямую в POST /processes/v1 (тип Document), чтобы пропустить этап захвата.
Эндпоинт
| Среда | URL |
|---|---|
| Production | GET https://api.idcloud.unico.app/documents/v1 |
| Sandbox | GET https://api.idcloud.uat.unico.app/documents/v1 |
Запрос
Заголовки
| Заголовок | Значение |
|---|---|
Authorization | Bearer <access_token> (см. Аутентификация) |
APIKEY | Выделенный API-ключ с включённой возможностью «Распознавание документов и повторное использование». |
Параметры запроса
| Параметр | Тип | Обязателен | Описание |
|---|---|---|---|
code | string | да | Идентификатор пользователя (CPF или CURP, без форматирования). |
type | string | да | Тип запрашиваемого документа. Допустимые значения: BR_RG, BR_CNH, BR_CIN, BR_PASSPORT. |
примечание
Значения type, указанные выше, специфичны для этого эндпоинта. Не путайте их с:
subject.duiTypeв запросах POST — использует префиксDUI_TYPE_*и идентифицирует человека, а не тип документа (например,DUI_TYPE_BR_CPF).documentTypeв ответе — использует полный путь реестра (например,unico.moja.dictionary.br.cnh.v2.Cnh).
Пример
- cURL
- Node.js
curl -X GET "https://api.idcloud.unico.app/documents/v1?code=12345678909&type=BR_CNH" \
-H "Authorization: Bearer $TOKEN" \
-H "APIKEY: $API_KEY"
import fetch from 'node-fetch';
const params = new URLSearchParams({ code: '12345678909', type: 'BR_CNH' });
const res = await fetch(
`https://api.idcloud.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
Ответы
200 OK
{
"items": [
{
"documentType": "unico.moja.dictionary.br.cnh.v2.Cnh",
"documentId": "doc-abc-123"
}
]
}
| Поле | Тип | Описание |
|---|---|---|
items | array | Список документов, доступных для повторного использования, найденных для пользователя. Пустой массив, если для указанных code и type не найдено ни одного документа, доступного для повторного использования. |
items[].documentType | string | Идентификатор типа документа. Возможные значения: 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 | Идентификатор документа. Передайте это значение в document.documentId при вызове POST /processes/v1, чтобы повторно использовать документ. |
Использование documentId для повторного использования
Получив documentId, передайте его в запросе процесса Document, чтобы пропустить захват:
{
"subject": {
"code": "12345678909",
"name": "Luke Skywalker"
},
"document": {
"purpose": "onboarding",
"authProcessId": "<biometric-process-id>",
"documentId": "doc-abc-123"
}
}
| Поле | Описание |
|---|---|
document.purpose | Бизнес-цель для этого процесса с документом. Допустимые значения: creditprocess, carpurchase, paybypaycheck, onboarding, fgts. Эти значения специфичны для Document API и отличаются от перечисления purpose биометрического SDK. |
document.authProcessId | ID биометрического процесса, ранее созданного для этого пользователя (из POST /processes/v1). |
document.documentId | ID документа, полученный из ответа этого эндпоинта. Если он указан, document.files можно не передавать — платформа автоматически получает ранее захваченный документ. |