Obter Processo

aviso

Antes de recuperar o processo, revise nossa configuração de webhook e estratégias de fallback — clique aqui.

No contrato API, a resposta do POST /processes/v1 já é o resultado final. Este endpoint existe para re-consultas — por exemplo, quando você precisa inspecionar um processo que persistiu anteriormente, ou auditar uma transação anterior.

Endpoint

Ambiente	URL
Produção	GET https://api.id.unico.app/processes/v1/{processId}
Sandbox	GET https://api.id.uat.unico.app/processes/v1/{processId}

Requisição

Headers

Header	Valor
Authorization	Bearer <access_token>
APIKEY	Chave de API provisionada.

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição
processId	string (UUID)	sim	Identificador do processo retornado por Criar Processo.

Exemplo

cURL

curl -X GET https://api.id.unico.app/processes/v1/$PROCESS_ID \
  -H "Authorization: Bearer $TOKEN" \
  -H "APIKEY: $API_KEY"

Node.js

import fetch from 'node-fetch';

const res = await fetch(
  `https://api.id.unico.app/processes/v1/${processId}`,
  {
    headers: {
      Authorization: `Bearer ${accessToken}`,
      APIKEY: apiKey
    }
  }
);
const result = await res.json();

Respostas

200 OK

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "unicoId": { "result": "yes" },
  "identityFraudsters": { "result": "inconclusive" },
  "government": { "serpro": 87 },
  "liveness": 1
}

Campo	Tipo	Descrição
id	string (UUID)	Identificador do processo.
status	integer	1 (processando), 2 (divergência), 3 (finalizado com sucesso), 4 (cancelado), 5 (erro).
unicoId.result	string	yes, no, inconclusive — veja Verificação de Identidade.
identityFraudsters.result	string	yes, inconclusive — veja Classificação de Risco.
government.serpro	integer	Pontuação de similaridade do Serpro (0–100, -1, -2). Veja Similaridade Serpro.
liveness	integer	1 (aprovado), 2 (reprovado) — veja Liveness.
score	integer	Pontuação probabilística de risco. Presente quando unicoId.result = inconclusive e a orquestração de risk score está ativa. Valores positivos indicam maior probabilidade de ser o titular; valores negativos indicam maior risco.

400 Bad Request

O parâmetro de caminho processId está ausente ou malformado. Veja Códigos de Erro abaixo.

403 Forbidden

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

404 Not Found

O processId não existe ou não pertence ao tenant autenticado.

410 Gone

O processo existe, mas resultou em erro. Retorna apenas id e status: 5.

429 Too Many Requests

Rate limit atingido. Veja Rate limits.

500 Internal Server Error

Erro inesperado no servidor.

Quando usar este endpoint

O contrato API retorna resultados de forma síncrona, portanto a maioria das integrações não precisa deste endpoint. Use-o quando:

• Você persistiu apenas o processId e precisa recuperar o resultado completo posteriormente (auditoria, suporte).
• Suspeita que a resposta original foi perdida em trânsito (erro de rede após a plataforma ter concluído o trabalho).
• Está construindo uma ferramenta de back-office que revisa processos históricos.

Códigos de Erro

400 Bad Request

Código	Mensagem	Descrição
20023	O parâmetro processId não foi informado.	O parâmetro process id está ausente.
20002	O parâmetro APIKey não foi informado.	O parâmetro APIKEY está ausente no header da requisição.
20001	O parâmetro authtoken não foi informado.	O parâmetro de token de integração está ausente no header da requisição.

404 Not Found

Código	Mensagem	Descrição
50001	O processo informado não foi encontrado.	O processo não existe no banco de dados.

403 Forbidden

Código	Mensagem	Descrição
30017	User does not have permission to perform this action.	JWT malformado ou usuário sem permissão para realizar esta operação.
10502	O token informado está expirado.	O access-token utilizado está expirado.
10501	O token informado é inválido.	O token de autenticação é inválido.
10201	O AppKey informado é inválido.	O parâmetro APIKEY não foi informado ou não existe.

410 Gone

O processo existe, mas resultou em erro. Retorna apenas id e status: 5.

500 Internal Server Error

Código	Mensagem	Descrição
99999	Internal failure! Try again later	Quando há um erro interno.