Obtener Documentos Reutilizables

Markdown ChatGPT Claude

Usa este endpoint para verificar si un usuario ya tiene un documento disponible para reutilizar antes de iniciar un nuevo flujo de captura de Document. Si se encuentra un documento, su documentId puede pasarse directamente a POST /processes/v1 (tipo Document) para omitir el paso de captura.

Endpoint

Entorno	URL
Producción	`GET https://api.idcloud.unico.app/documents/v1`
Sandbox	`GET https://api.idcloud.uat.unico.app/documents/v1`

Solicitud

Headers

Header	Valor
`Authorization`	`Bearer <access_token>` (ver Autenticación)
`APIKEY`	API key provisionada con Captura de Documentos y Reutilización habilitada.

Parámetros de consulta

Parámetro	Tipo	Obligatorio	Descripción
`code`	string	sí	Identificador del usuario (CPF o CURP, sin formato).
`type`	string	sí	Tipo de documento a consultar. Valores aceptados: `BR_RG`, `BR_CNH`, `BR_CIN`, `BR_PASSPORT`.

nota

Los valores de type anteriores son específicos de este endpoint. No los confundas con:

subject.duiType en solicitudes POST — usa el prefijo DUI_TYPE_* e identifica a la persona, no el tipo de documento (ej.: DUI_TYPE_BR_CPF).
documentType en la respuesta — usa la ruta completa del registro (ej.: unico.moja.dictionary.br.cnh.v2.Cnh).

Ejemplo

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

Respuestas

200 OK

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

Campo	Tipo	Descripción
`items`	array	Lista de documentos reutilizables encontrados para el usuario. Arreglo vacío si no se encontró ningún documento reutilizable para el `code` y `type` proporcionados.
`items[].documentType`	string	Identificador del tipo de documento. Valores posibles: `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	Identificador del documento. Pasa este valor en `document.documentId` en `POST /processes/v1` para reutilizar el documento.

Uso del documentId para reutilización

Una vez que tengas un documentId, pásalo en la solicitud del proceso de Document para omitir la captura:

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

Campo	Descripción
`document.purpose`	Propósito de negocio para este proceso de documento. Valores aceptados: `creditprocess`, `carpurchase`, `paybypaycheck`, `onboarding`, `fgts`. Estos valores son específicos de la Document API y difieren del enum `purpose` del SDK biométrico.
`document.authProcessId`	ID del proceso biométrico creado previamente para este usuario (a partir de `POST /processes/v1`).
`document.documentId`	ID del documento obtenido de la respuesta de este endpoint. Cuando se proporciona, `document.files` puede omitirse: la plataforma recupera automáticamente el documento capturado previamente.

Códigos de Error

400 Bad Request
403 Forbidden
404 Not Found
429 Too Many Requests
500 Internal Server Error

Código	Mensaje	Descripción
`20507`	O parâmetro subject.code é inválido.	Valor de identificador (CPF o CURP) malformado o inexistente.
`20002`	O parâmetro APIKey não foi informado.	Falta el header APIKEY.
`20001`	O parâmetro authtoken não foi informado.	Falta el header del token de autenticación.

Falta el token Bearer o el APIKEY, o están expirados o son inválidos.

Código	Mensaje	Descripción
`30020`	The provided authorization token does not have permission to perform this action.	El token no tiene permiso para acceder a la selfie del documento.
`30017`	User does not have permission to perform this action.	JWT malformado o usuario sin permiso para realizar esta operación.
`10502`	O token informado está expirado.	Access token expirado.
`10501`	O token informado é inválido.	Token de autenticación inválido.
`10201`	O AppKey informado é inválido.	APIKEY ausente o inexistente.

Código	Mensaje	Descripción
`99987`	Attachment not found.	No se encontró el adjunto asociado al documento.
`50001`	The process is not found.	No se encontró ningún documento para los parámetros proporcionados.

Código	Mensaje	Descripción
`99999`	Internal failure! Try again later.	Error de procesamiento del lado del servidor.

Endpoint​

Solicitud​

Ejemplo​

Respuestas​

Uso del documentId para reutilización​

Códigos de Error​