GET
/
consultas
Listar consultas disponíveis
curl --request GET \
  --url https://api.periciadecredito.com.br/consultas \
  --header 'x-access-token: <api-key>'
{
  "consultas": [
    {
      "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.9,
      "price_source": "universal",
      "status": "em_producao",
      "category_id": [
        3
      ],
      "parametros": [
        "cpf"
      ],
      "limite_diario": 500,
      "limite_mensal": 10000,
      "expira_em": null,
      "usado_hoje": 12,
      "usado_mes": 240
    },
    {
      "id": 3,
      "name": "scr_pf",
      "display_name": "SCR — Pessoa Física",
      "description": "Histórico de crédito no Banco Central (Sistema de Informações de Crédito).",
      "price": 12.5,
      "price_source": "table",
      "status": "em_producao",
      "category_id": [
        5
      ],
      "parametros": [
        "cpf",
        "referenceMonth",
        "referenceYear"
      ],
      "limite_diario": null,
      "limite_mensal": 5000,
      "expira_em": null,
      "usado_hoje": 3,
      "usado_mes": 58
    }
  ]
}

​
Consultas e permissões

Cada usuário vê apenas as consultas com permissão ativa liberada para o seu perfil, já com o preço resolvido para a conta (override individual > tabela vinculada > preço universal, indicado em price_source) e os limites e consumo atual de uso. Use o id de cada consulta para:

​
Limites de uso

Os campos limite_diario, limite_mensal, usado_hoje e usado_mes permitem que sua integração saiba, antes de executar, se ainda há margem de uso — evitando bater em 403 desnecessariamente. null em limite_diario ou limite_mensal significa que não há limite configurado naquela janela.

​
Ciclo de vida (status)

statusCliente pode executar?
em_producaoSim
em_breveNão — liberada mas ainda não disponível, POST /consultas/executar/{id} retorna 400
com_erroNão para clientes — provedor com problema conhecido
Consultas com status em_auditoria nunca aparecem nesta listagem, mesmo com permissão concedida.
Esta é a visão do cliente autenticado. Contas administrativas recebem uma listagem interna diferente, usada pelo backoffice, com todas as consultas da plataforma (ativas ou não) — fora do escopo desta documentação.

Authorizations

​
x-access-token
string
header
required

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

Response

Lista de consultas disponíveis para o usuário autenticado.

​
consultas
object[]