- 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.
Datasets e preços
Consulte datasets disponíveis, preço aplicado, campos adicionais e estrutura de retorno.
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.
Como uma consulta funciona
1
Escolha o tipo de consulta
Defina se a busca será por CPF, CNPJ, documento processual ou placa.
2
Liste datasets disponíveis
Use a listagem de datasets para identificar módulos ativos, preços, campos adicionais e estrutura de retorno.
3
Envie o identificador e os datasets
Execute a consulta informando o documento ou identificador e os IDs dos datasets desejados.
4
Interprete resultados e custos
Leia
result, datasets_status, valores consumidos, estornos e mensagens retornadas.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.Campos adicionais
Alguns datasets podem exigir parâmetros complementares. Esses campos aparecem emadditional_fields na listagem de datasets.
Exemplo:
additional, usando o ID do dataset como chave.
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.
Ambiente de teste
Veja como usar sandbox para validar integrações sem consumir saldo.
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;
- subcontas podem respeitar limites mensais configurados pela conta principal.
Consultas com múltiplos datasets podem retornar resultados parciais caso algum dataset falhe. Nesses casos, confira o status individual de cada dataset.
Retorno
As respostas seguem um formato padronizado:result contém os dados retornados pelos datasets selecionados.
Em consultas com múltiplos datasets, o retorno também pode trazer informações como:
Consultas assíncronas
Algumas consultas podem ser processadas em segundo plano. Nesses casos, a resposta inicial retorna um identificador para acompanhar o andamento e consultar o resultado final depois.Resultado assíncrono
Consulte o andamento e o resultado final de consultas iniciadas em segundo plano.
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.Histórico de consultas
Entenda como acompanhar consultas assíncronas, revisar resultados anteriores e interpretar custos, erros e status por dataset.
Boas práticas
- Liste datasets antes de executar a consulta.
- Use apenas datasets necessários para o objetivo da operação.
- Valide CPF, CNPJ, placa ou identificador antes de consultar.
- Use sandbox para testar payloads e respostas.
- Trate resultados parciais quando a consulta tiver múltiplos datasets.
- Não armazene documentos ou retornos sensíveis em logs sem necessidade.
- Trate erros de saldo, plano, permissão e provedor separadamente.
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.
Histórico de consultas
Veja como revisar consultas anteriores e acompanhar resultados assíncronos.

