- um documento ou identificador de entrada;
- uma lista de datasets selecionados;
- regras de plano, saldo e permissões;
- um retorno padronizado com os dados encontrados.
Tipos de consulta
Pessoa física
Consulte informações vinculadas a CPF, como dados cadastrais, risco, protestos, scores, presença em cobrança e outros datasets disponíveis.
Pessoa jurídica
Consulte informações vinculadas a CNPJ, incluindo dados cadastrais, atividade econômica, quadro societário, protestos, scores, dívida ativa e outros datasets.
Processos
Consulte processos judiciais vinculados a CPF ou CNPJ em bases processuais disponíveis.
Veículos
Consulte dados veiculares a partir da placa, incluindo características do veículo, situação, restrições e indicadores disponíveis.
Datasets
Cada consulta é composta por um ou mais datasets. Um dataset representa uma base ou módulo de informação específico, como dados básicos, protestos, score de crédito, mandados de prisão, processos judiciais ou dados veiculares. Ao selecionar datasets, o sistema calcula a estimativa da consulta com base nos valores configurados para sua conta.Consulta de teste
Quando disponível, a consulta de teste permite validar a integração sem consumir saldo. Ela é útil para:- testar autenticação;
- validar payloads;
- entender a estrutura de retorno;
- simular respostas no ambiente de desenvolvimento.
Consultas de teste podem retornar dados simulados ou controlados, conforme a funcionalidade utilizada.
Cobrança
A cobrança depende dos datasets selecionados e das regras comerciais da conta. Em geral:- datasets concluídos podem gerar cobrança;
- datasets com falha podem ser estornados conforme regra aplicável;
- contas pré-pagas precisam ter saldo disponível;
- contas pós-pagas respeitam limite mensal e situação da fatura.
Retorno
As respostas seguem um formato padronizado:result contém os dados retornados pelos datasets selecionados.
Histórico
Consultas realizadas podem ficar disponíveis no histórico da conta, conforme o plano contratado e as permissões do usuário. O histórico permite revisar consultas anteriores sem executar uma nova chamada.Próximos passos
Consultar pessoa física
Veja como estruturar uma consulta por CPF.
Consultar pessoa jurídica
Veja como estruturar uma consulta por CNPJ.
Consultar processos
Entenda como consultar processos vinculados a CPF ou CNPJ.
Códigos de erro
Consulte os erros mais comuns relacionados a consultas.

