GET
/
consultas
/
{id}
Detalhes de uma consulta
curl --request GET \
  --url https://api.periciadecredito.com.br/consultas/{id} \
  --header 'x-access-token: <api-key>'
{
  "consulta": {
    "id": 1,
    "name": "kyc_pf",
    "display_name": "KYC — Pessoa Física",
    "description": "Dados cadastrais, situação na Receita Federal e informações de contato de pessoas físicas.",
    "price": "4.90",
    "is_active": true,
    "status": "em_producao",
    "created_at": "2025-11-02T12:00:00.000Z",
    "updated_at": "2026-01-15T09:30:00.000Z",
    "parametros": [
      {
        "parameter_id": 7,
        "name": "cpf",
        "display_name": "CPF",
        "type": "string",
        "is_required": true,
        "display_order": 1
      }
    ],
    "produtos": [
      {
        "query_product_id": 12,
        "product_id": 4,
        "name": "kyc",
        "display_name": "KYC",
        "description": null,
        "display_order": 1,
        "provedores": [
          {
            "provider_id": 2,
            "name": "gyra",
            "display_name": "Gyra+",
            "priority": 1,
            "timeout_ms": 15000,
            "max_retries": 2,
            "is_active": true
          }
        ]
      }
    ],
    "categorias": [
      {
        "category_id": 3,
        "name": "cadastral",
        "display_name": "Cadastral"
      }
    ]
  }
}

​
Para que serve

Antes de chamar POST /consultas/executar/{id}, use este endpoint para descobrir exatamente quais parâmetros a consulta espera, quais são obrigatórios, e quais produtos/categorias ela envolve. 
GET /consultas/1
O id vem da listagem em GET /consultas.

​
Lendo os parâmetros

O array parametros já vem ordenado pela ordem de exibição recomendada (display_order). Monte o body de POST /consultas/executar/{id} incluindo pelo menos todos os campos com is_required: true:
Resposta (trecho)
{
  "consulta": {
    "id": 1,
    "name": "kyc_pf",
    "display_name": "KYC — Pessoa Física",
    "parametros": [
      {
        "parameter_id": 7,
        "name": "cpf",
        "display_name": "CPF",
        "type": "string",
        "is_required": true,
        "display_order": 1
      }
    ]
  }
}
Nesse exemplo, o body da execução deve conter { "cpf": "..." }.

​
Campo price: string, não número

Diferente de GET /consultas (que resolve e retorna o preço específico do seu cliente já como number), este endpoint devolve o preço universal da consulta exatamente como está no banco — uma string numérica (ex: "4.90"). Se você precisa do preço efetivo cobrado da sua conta, use GET /consultas.

​
Produtos e provedores

O array produtos descreve os produtos executados internamente por essa consulta, cada um com seus provedores configurados (prioridade, timeout, retries). Essa informação é informativa — você nunca chama provedores diretamente, apenas POST /consultas/executar/{id}.

​
Consultas ocultas

Consultas com status em_auditoria retornam 404 para contas não-admin, mesmo que o id exista — o mesmo tratamento dado a um ID inexistente, para não vazar a existência da consulta.

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

​
id
integer
required

ID da consulta. Obtenha via GET /consultas.

Response

Detalhamento completo da consulta.

​
consulta
object