Obter Documentos Reutilizáveis

Use este endpoint para verificar se um usuário já possui um documento disponível para reutilização antes de iniciar um novo fluxo de captura de Documento. Se um documento for encontrado, seu documentId pode ser passado diretamente para POST /processes/v1 (tipo Document) para pular a etapa de captura.

Endpoint

Ambiente	URL
Produção	GET https://api.id.unico.app/documents/v1
Sandbox	GET https://api.id.uat.unico.app/documents/v1

Requisição

Headers

Header	Valor
Authorization	Bearer <access_token> (veja Autenticação)
APIKEY	Chave de API provisionada com Captura e Reutilização de Documentos habilitadas.

Parâmetros de query

Parâmetro	Tipo	Obrigatório	Descrição
code	string	sim	Identificador do usuário (CPF ou CURP, sem formatação).
type	string	sim	Tipo de documento a consultar. Valores aceitos: BR_RG, BR_CNH, BR_CIN, BR_PASSPORT.

observação

Os valores de type acima são específicos deste endpoint. Não os confunda com:

• subject.duiType em requisições POST — usa o prefixo DUI_TYPE_* e identifica a pessoa, não o tipo de documento (ex.: DUI_TYPE_BR_CPF).
• documentType na resposta — usa o caminho completo do registro (ex.: unico.moja.dictionary.br.cnh.v2.Cnh).

Exemplo

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

Respostas

200 OK

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

Campo	Tipo	Descrição
items	array	Lista de documentos reutilizáveis encontrados para o usuário. Array vazio se nenhum documento reutilizável for encontrado para o code e type informados.
items[].documentType	string	Identificador do tipo de documento. Valores possíveis: 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 do documento. Passe este valor em document.documentId no POST /processes/v1 para reutilizar o documento.

403 Forbidden

Bearer token ou APIKEY ausente, expirado ou inválido.

429 Too Many Requests

Limite de taxa atingido. Tente novamente após o intervalo indicado no cabeçalho de resposta Retry-After. Consulte Limites de taxa.

Utilizando o documentId para reutilização

Uma vez que você tenha um documentId, passe-o na requisição de processo de Documento para pular a captura:

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

Campo	Descrição
document.purpose	Finalidade de negócio para este processo de documento. Valores aceitos: creditprocess, carpurchase, paybypaycheck, onboarding, fgts. Esses valores são específicos da API de Documento e diferem do enum purpose do SDK biométrico.
document.authProcessId	ID do processo biométrico criado anteriormente para este usuário (a partir de POST /processes/v1).
document.documentId	ID do documento obtido na resposta deste endpoint. Quando fornecido, document.files pode ser omitido — a plataforma recupera automaticamente o documento capturado anteriormente.

Para o esquema completo da requisição do processo de Documento, consulte Criar Processo de Documento.

Códigos de Erro

400 Bad Request

Código	Mensagem	Descrição
20507	O parâmetro subject.code é inválido.	Valor do identificador malformado ou inexistente (CPF ou CURP).
20002	O parâmetro APIKey não foi informado.	Header APIKEY ausente.
20001	O parâmetro authtoken não foi informado.	Header de token de autenticação ausente.

403 Forbidden

Código	Mensagem	Descrição
30017	Jwt header is an invalid JSON.	O access-token contém caracteres inválidos.
10502	O token informado está expirado.	Access-token expirado.
10501	O token informado é inválido.	Token de autenticação inválido.
10201	O AppKey informado é inválido.	APIKEY ausente ou inexistente.

404 Not Found

Código	Mensagem	Descrição
99987	Attachment not found.	Anexo associado ao documento não foi encontrado.
50001	The process is not found.	Nenhum documento encontrado para os parâmetros informados.

500 Internal Server Error

Código	Mensagem	Descrição
99999	Internal failure! Try again later.	Erro de processamento no servidor.