GET
/
consultas
Listar consultas disponíveis
curl --request GET \
  --url https://api.sollosconsultas.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.",
      "is_active": true
    },
    {
      "id": 2,
      "name": "kyc_pj",
      "display_name": "KYC — Pessoa Jurídica",
      "description": "Dados cadastrais, quadro societário e situação da empresa na Receita Federal.",
      "is_active": true
    },
    {
      "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).",
      "is_active": true
    }
  ]
}

​
Consultas e permissões

Cada usuário vê apenas as consultas liberadas para o seu perfil. O mesmo endpoint retorna resultados diferentes para usuários diferentes dependendo das permissões configuradas na plataforma. Use o id de cada consulta para executá-la em POST /consultas/executar/{id}. Para ver os parâmetros aceitos por uma consulta específica antes de executar, use GET /consultas/{id}.

​
Consultas inativas

Consultas com is_active: false estão temporariamente desativadas e retornarão 400 se tentadas. Elas ainda aparecem na listagem para que você possa identificá-las.

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[]