GET
/
consultas
/
resultado
/
{consultaId}
Recuperar resultado
curl --request GET \
  --url https://api.periciadecredito.com.br/consultas/resultado/{consultaId} \
  --header 'x-access-token: <api-key>'
{
  "status": "completed",
  "success": true,
  "id": 1,
  "name": "KYC — Pessoa Física",
  "query_execution": 4201,
  "data_execucao": "10/04/2026 14:32:00",
  "resultados": {
    "nome": "JOÃO DA SILVA",
    "cpf": "123.456.789-00",
    "situacao_receita": "REGULAR"
  }
}
Este endpoint não faz parte do fluxo normal. POST /consultas/executar/{id} já devolve o resultado diretamente na resposta — a maior parte das integrações nunca precisa chamar este endpoint.

​
Quando usar este endpoint

Existem exatamente dois cenários:
Se POST /consultas/executar/{id} responder 504, a execução continua rodando em segundo plano. Passe o consultaId (hash) recebido na resposta de timeout e faça polling a cada ~2 segundos até status deixar de ser pending.
Passe o query_execution (ID numérico) retornado por uma execução completed. Funciona por até 90 dias após a execução — depois disso, o payload expira e o endpoint responde 410.

​
Dois formatos, duas respostas diferentes

O path aceita tanto um hash SHA-256 (64 caracteres hexadecimais) quanto um ID numérico, e a API detecta automaticamente qual é qual. O formato do corpo da resposta muda dependendo de qual você usou:
Formato do consultaIdQuando você tem esse valorCampo com o payload
Hash SHA-256Recebido em uma resposta 504resultados
ID numéricoquery_execution de uma execução completedresponse
{
  "status": "completed",
  "success": true,
  "id": 1,
  "name": "KYC — Pessoa Física",
  "query_execution": 4201,
  "data_execucao": "10/04/2026 14:32:00",
  "resultados": {
    "nome": "JOÃO DA SILVA",
    "cpf": "123.456.789-00",
    "situacao_receita": "REGULAR"
  }
}
Não assuma que o payload sempre vem em resultados — se você está reconsultando pelo query_execution (ID numérico), o campo se chama response.

​
Estados possíveis (formato hash)

Campo statusHTTPO que significa
pending202O job ainda está na fila ou sendo processado pelo provedor
completed200Resultado disponível no campo resultados
failed500O provedor retornou um erro após todas as tentativas
pending (202) só ocorre no formato hash — pelo ID numérico a resposta é sempre 200, 403, 404 ou 410.
Aguarde ~2 segundos e repita a requisição. Implemente um limite máximo de tentativas (recomendamos 15) para evitar loops infinitos.
Salve o query_execution — ele é o ID permanente desta execução e pode ser usado tanto para reconsultar aqui (via ID numérico) quanto em GET /consultas/logs/details/{id}.
O provedor não conseguiu responder após todas as tentativas de retry e failover. O campo error descreve a causa.

​
Erros específicos do formato por ID numérico

HTTPQuando
403A execução pertence a outro usuário (você só pode acessar as suas, exceto contas admin)
404Nenhum registro encontrado com esse ID
410O payload expirou pela política de retenção de 90 dias — os metadados continuam em GET /consultas/logs/details/{id}, mas o conteúdo não pode mais ser recuperado
Para não depender do prazo de retenção, salve o query_execution junto com os dados retornados assim que receber o status completed — ou recupere-o depois via GET /consultas/logs/details/{id}, que também respeita o mesmo prazo mas devolve 200 com response: null em vez de 410.

Authorizations

​
x-access-token
string
header
required

Token JWT retornado pelo endpoint POST /auth/login. Inclua este header em todas as requisições autenticadas.

Path Parameters

​
consultaId
string
required

Hash SHA-256 (consultaId de uma resposta 504) ou ID numérico (query_execution de uma execução completed).

Response

Resultado disponível. O formato do corpo depende de qual caminho (hash ou ID numérico) foi usado.

Envelope de uma execução concluída — devolvido tanto por POST /consultas/executar/{id} quanto por GET /consultas/resultado/{consultaId} (formato hash).

​
status
enum<string>
Available options:
completed
Example:

"completed"

​
success
boolean

true se todos os produtos da consulta retornaram dados com sucesso. false se pelo menos um produto falhou — nesse caso a resposta HTTP é 500, mas o corpo mantém este mesmo formato (resultados traz o(s) erro(s) por produto).

Example:

true

​
id
integer

ID da consulta executada (o mesmo {id} do path de POST /consultas/executar/{id})

Example:

1

​
name
string

Nome legível da consulta

Example:

"KYC — Pessoa Física"

​
query_execution
integer

ID permanente desta execução. Use em GET /consultas/logs/details/{id} ou em GET /consultas/resultado/{query_execution} para recuperar o resultado no futuro.

Example:

4201

​
data_execucao
string

Data e hora da execução no fuso de Brasília

Example:

"10/04/2026 14:32:00"

​
resultados
object

Dados retornados pelo(s) provedor(es). Se a consulta tem um único produto: este campo é o objeto de dados diretamente (sucesso) ou { product_name, error, status } (falha). Se a consulta tem múltiplos produtos: este campo é um array, um item por produto, cada um { product_name, data } (sucesso) ou { product_name, error, status } (falha) — misturando sucessos e falhas quando aplicável.