API AutoConsulta
string
Properties for Antecedentes Judicial CNPJ:const · required
Properties for Variant 1:const · requiredstring · uuid · requiredstring · enumnumber | nullinteger | nullboolean
string
Properties for Antecedentes Judicial CNPJ:const · required
Properties for Variant 1:const · requiredstring · uuid · requiredstring · enumnumber | nullinteger | nullboolean
string · uuid · requiredboolean · requiredstring · enum · requiredstring · uuid · requiredstringnumber | boolean | null
string · requiredstring · requiredboolean · requiredbooleanstring | null · uuid
Consultas
Executar uma consulta e acompanhar o resultado.
Executar uma consulta
POST
https://api.consultas.us
/
Executa uma consulta e cobra a conta. O que volta depende do produto: os síncronos devolvem o resultado na própria resposta; os assíncronos devolvem async: true com um consultation_id para acompanhar em GET /status.
⚠️ Confira sempre o campo success — alguns desfechos de falha chegam com HTTP 200.
Headers
Idempotency-KeyRepetir o mesmo valor faz a chamada valer por uma só: a segunda devolve o resultado da primeira sem cobrar de novo. Use quando precisar reenviar com segurança.
Executar uma consulta › Request Body
oneOf
Exactly one variant must match.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · consultation_type="antecedentes-cnpj" · requires: input_data | |
| type = object · consultation_type="antecedentes-cpf" · requires: input_data | |
| type = object · consultation_type="cadastro-pf-completo" · requires: input_data | |
| type = object · consultation_type="cadastro-pj-completo" · requires: input_data | |
| type = object · consultation_type="cartao-cnpj" · requires: input_data | |
| type = object · consultation_type="cartao-cpf" · requires: input_data | |
| type = object · consultation_type="ceaf" · requires: input_data | |
| type = object · consultation_type="ceis" · requires: input_data | |
| type = object · consultation_type="cepim" · requires: input_data | |
| type = object · consultation_type="certificado-de-seguranca-veicular-csv" · requires: input_data | |
| type = object · consultation_type="cnep" · requires: input_data | |
| type = object · consultation_type="cnh-completa" · requires: input_data | |
| type = object · consultation_type="cnh-completa-v4" · requires: input_data | |
| type = object · consultation_type="cnh-estadual-ac-completa" · requires: input_data | |
| type = object · consultation_type="cnh-estadual-al-completa" · requires: input_data | |
| type = object · consultation_type="cnh-estadual-am-completa" · requires: input_data | |
| type = object · consultation_type="cnh-estadual-ap-completa" · requires: input_data | |
| type = object · consultation_type="cnh-estadual-ce-completa" · requires: input_data | |
| type = object · consultation_type="cnh-estadual-go-completa" · requires: input_data | |
| type = object · consultation_type="cnh-estadual-ma-completa" · requires: input_data | |
| type = object · consultation_type="cnh-estadual-ms-completa" · requires: input_data | |
| type = object · consultation_type="cnh-estadual-mt-completa" · requires: input_data | |
| type = object · consultation_type="cnh-estadual-pa-completa" · requires: input_data | |
| type = object · consultation_type="cnh-estadual-pr-completa" · requires: input_data | |
| type = object · consultation_type="cnh-estadual-pr-completa-v2" · requires: input_data | |
| type = object · consultation_type="cnh-estadual-rj-completa" · requires: input_data | |
| type = object · consultation_type="cnh-estadual-rn-completa" · requires: input_data | |
| type = object · consultation_type="cnh-estadual-se-completa" · requires: input_data | |
| type = object · consultation_type="cnh-estadual-to-completa" · requires: input_data | |
| type = object · consultation_type="cnh-foto" · requires: input_data | |
| type = object · consultation_type="cnh-nacional-simples" · requires: input_data | |
| type = object · consultation_type="cnj-improbidade" · requires: input_data | |
| type = object · consultation_type="cnj-mandados-prisao" · requires: input_data | |
| type = object · consultation_type="consorcio" · requires: input_data | |
| type = object · consultation_type="consulta-agregados" · requires: input_data | |
| type = object · consultation_type="consulta-basica-de-veiculo" · requires: input_data | |
| type = object · consultation_type="consulta-bin-nacional" · requires: input_data | |
| type = object · consultation_type="consulta-cnpj" · requires: input_data | |
| type = object · consultation_type="consulta-de-recall" · requires: input_data | |
| type = object · consultation_type="consulta-de-roubo-e-furto" · requires: input_data | |
| type = object · consultation_type="consulta-de-sinistro" · requires: input_data | |
| type = object · consultation_type="consulta-nfe-chave" · requires: input_data | |
| type = object · consultation_type="consulta-processo-cnj" · requires: input_data | |
| type = object · consultation_type="credito-sintetico-pf" · requires: input_data | |
| type = object · consultation_type="credito-sintetico-pj" · requires: input_data | |
| type = object · consultation_type="debitos-ac" · requires: input_data | |
| type = object · consultation_type="debitos-al" · requires: input_data | |
| type = object · consultation_type="debitos-am" · requires: input_data | |
| type = object · consultation_type="debitos-ap" · requires: input_data | |
| type = object · consultation_type="debitos-ce" · requires: input_data | |
| type = object · consultation_type="debitos-df" · requires: input_data | |
| type = object · consultation_type="debitos-ma" · requires: input_data | |
| type = object · consultation_type="debitos-mg-simples" · requires: input_data | |
| type = object · consultation_type="debitos-ms" · requires: input_data | |
| type = object · consultation_type="debitos-mt" · requires: input_data | |
| type = object · consultation_type="debitos-pa" · requires: input_data | |
| type = object · consultation_type="debitos-pb" · requires: input_data | |
| type = object · consultation_type="debitos-pi" · requires: input_data | |
| type = object · consultation_type="debitos-pr" · requires: input_data | |
| type = object · consultation_type="debitos-rj" · requires: input_data | |
| type = object · consultation_type="debitos-rn" · requires: input_data | |
| type = object · consultation_type="debitos-ro" · requires: input_data | |
| type = object · consultation_type="debitos-rr" · requires: input_data | |
| type = object · consultation_type="debitos-sc" · requires: input_data | |
| type = object · consultation_type="debitos-sp" · requires: input_data | |
| type = object · consultation_type="debitos-to" · requires: input_data | |
| type = object · consultation_type="enriquecimento-lead" · requires: input_data | |
| type = object · consultation_type="historico-profissional-renda" · requires: input_data | |
| type = object · consultation_type="inscricao-estadual-sp" · requires: input_data | |
| type = object · consultation_type="leniencia" · requires: input_data | |
| type = object · consultation_type="mapa-relacionamento-cnpj" · requires: input_data | |
| type = object · consultation_type="ofac-sancoes" · requires: input_data | |
| type = object · consultation_type="onu-sancoes" · requires: input_data | |
| type = object · consultation_type="orgaos-antt-transportador" · requires: input_data | |
| type = object · consultation_type="orgaos-antt-veiculo" · requires: input_data | |
| type = object · consultation_type="orgaos-der-pr" · requires: input_data | |
| type = object · consultation_type="orgaos-detran-sp-acompanhamento" · requires: input_data | |
| type = object · consultation_type="orgaos-medidor-velocidade" · requires: input_data | |
| type = object · consultation_type="orgaos-pge-sp" · requires: input_data | |
| type = object · consultation_type="orgaos-prf" · requires: input_data | |
| type = object · consultation_type="pep" · requires: input_data | |
| type = object · consultation_type="pessoas-veiculos" · requires: input_data | |
| type = object · consultation_type="pf-cnd-criminal" · requires: input_data | |
| type = object · consultation_type="pgfn-cnd-federal-cnpj" · requires: input_data | |
| type = object · consultation_type="pgfn-cnd-federal-cpf" · requires: input_data | |
| type = object · consultation_type="protestos-brasil" · requires: input_data | |
| type = object · consultation_type="sancoes-internacionais" · requires: input_data | |
| type = object · consultation_type="scr-bacen-analitico" · requires: input_data | |
| type = object · consultation_type="scr-bacen-resumo" · requires: input_data | |
| type = object · consultation_type="sit-trabalho-escravo" · requires: input_data | |
| type = object · consultation_type="situacao-cadastral-cpf" · requires: input_data | |
| type = object · consultation_type="tabela-fipe-placa" · requires: input_data | |
| type = object · consultation_type="tcu-consolidada-pj" · requires: input_data | |
| type = object · consultation_type="tcu-inabilitados" · requires: input_data | |
| type = object · consultation_type="tcu-inidoneos" · requires: input_data | |
| type = object · consultation_type="tst-cndt" · requires: input_data | |
| type = object · consultation_type="veiculos-base-nacional-v2" · requires: input_data | |
| type = object · consultation_type="veiculos-bin-estadual" · requires: input_data | |
| type = object · consultation_type="veiculos-cronotacografo" · requires: input_data | |
| type = object · consultation_type="veiculos-infracoes-v3" · requires: input_data |
consultation_typeConst value: antecedentes-cnpj
Entrada_antecedentes_cnpj · required
Executar uma consulta › Responses
A consulta foi aceita. Veja success para saber o desfecho.
oneOf
Exactly one variant must match.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: success, consultation_id, result | |
| type = object · requires: success, async, consultation_id +1 more | |
| type = object · requires: success, error, code |
successConst value:
consultation_idobject · required
O resultado da consulta.
environmentEnum values:
production
sandbox
balanceSaldo da carteira depois da cobrança.
remaining_unitsUnidades restantes, quando o pagamento saiu de um pacote.
idempotentPresente e true quando esta resposta repete uma chamada anterior, sem nova cobrança.
Executar uma consulta (forma longa)
POST
https://api.consultas.us
/consultations
Idêntica a POST /. As duas formas chegam ao mesmo motor e têm o mesmo efeito e o mesmo custo — use a que preferir.
Headers
Idempotency-KeyRepetir o mesmo valor faz a chamada valer por uma só: a segunda devolve o resultado da primeira sem cobrar de novo. Use quando precisar reenviar com segurança.
Executar uma consulta (forma longa) › Request Body
oneOf
Exactly one variant must match.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · consultation_type="antecedentes-cnpj" · requires: input_data | |
| type = object · consultation_type="antecedentes-cpf" · requires: input_data | |
| type = object · consultation_type="cadastro-pf-completo" · requires: input_data | |
| type = object · consultation_type="cadastro-pj-completo" · requires: input_data | |
| type = object · consultation_type="cartao-cnpj" · requires: input_data | |
| type = object · consultation_type="cartao-cpf" · requires: input_data | |
| type = object · consultation_type="ceaf" · requires: input_data | |
| type = object · consultation_type="ceis" · requires: input_data | |
| type = object · consultation_type="cepim" · requires: input_data | |
| type = object · consultation_type="certificado-de-seguranca-veicular-csv" · requires: input_data | |
| type = object · consultation_type="cnep" · requires: input_data | |
| type = object · consultation_type="cnh-completa" · requires: input_data | |
| type = object · consultation_type="cnh-completa-v4" · requires: input_data | |
| type = object · consultation_type="cnh-estadual-ac-completa" · requires: input_data | |
| type = object · consultation_type="cnh-estadual-al-completa" · requires: input_data | |
| type = object · consultation_type="cnh-estadual-am-completa" · requires: input_data | |
| type = object · consultation_type="cnh-estadual-ap-completa" · requires: input_data | |
| type = object · consultation_type="cnh-estadual-ce-completa" · requires: input_data | |
| type = object · consultation_type="cnh-estadual-go-completa" · requires: input_data | |
| type = object · consultation_type="cnh-estadual-ma-completa" · requires: input_data | |
| type = object · consultation_type="cnh-estadual-ms-completa" · requires: input_data | |
| type = object · consultation_type="cnh-estadual-mt-completa" · requires: input_data | |
| type = object · consultation_type="cnh-estadual-pa-completa" · requires: input_data | |
| type = object · consultation_type="cnh-estadual-pr-completa" · requires: input_data | |
| type = object · consultation_type="cnh-estadual-pr-completa-v2" · requires: input_data | |
| type = object · consultation_type="cnh-estadual-rj-completa" · requires: input_data | |
| type = object · consultation_type="cnh-estadual-rn-completa" · requires: input_data | |
| type = object · consultation_type="cnh-estadual-se-completa" · requires: input_data | |
| type = object · consultation_type="cnh-estadual-to-completa" · requires: input_data | |
| type = object · consultation_type="cnh-foto" · requires: input_data | |
| type = object · consultation_type="cnh-nacional-simples" · requires: input_data | |
| type = object · consultation_type="cnj-improbidade" · requires: input_data | |
| type = object · consultation_type="cnj-mandados-prisao" · requires: input_data | |
| type = object · consultation_type="consorcio" · requires: input_data | |
| type = object · consultation_type="consulta-agregados" · requires: input_data | |
| type = object · consultation_type="consulta-basica-de-veiculo" · requires: input_data | |
| type = object · consultation_type="consulta-bin-nacional" · requires: input_data | |
| type = object · consultation_type="consulta-cnpj" · requires: input_data | |
| type = object · consultation_type="consulta-de-recall" · requires: input_data | |
| type = object · consultation_type="consulta-de-roubo-e-furto" · requires: input_data | |
| type = object · consultation_type="consulta-de-sinistro" · requires: input_data | |
| type = object · consultation_type="consulta-nfe-chave" · requires: input_data | |
| type = object · consultation_type="consulta-processo-cnj" · requires: input_data | |
| type = object · consultation_type="credito-sintetico-pf" · requires: input_data | |
| type = object · consultation_type="credito-sintetico-pj" · requires: input_data | |
| type = object · consultation_type="debitos-ac" · requires: input_data | |
| type = object · consultation_type="debitos-al" · requires: input_data | |
| type = object · consultation_type="debitos-am" · requires: input_data | |
| type = object · consultation_type="debitos-ap" · requires: input_data | |
| type = object · consultation_type="debitos-ce" · requires: input_data | |
| type = object · consultation_type="debitos-df" · requires: input_data | |
| type = object · consultation_type="debitos-ma" · requires: input_data | |
| type = object · consultation_type="debitos-mg-simples" · requires: input_data | |
| type = object · consultation_type="debitos-ms" · requires: input_data | |
| type = object · consultation_type="debitos-mt" · requires: input_data | |
| type = object · consultation_type="debitos-pa" · requires: input_data | |
| type = object · consultation_type="debitos-pb" · requires: input_data | |
| type = object · consultation_type="debitos-pi" · requires: input_data | |
| type = object · consultation_type="debitos-pr" · requires: input_data | |
| type = object · consultation_type="debitos-rj" · requires: input_data | |
| type = object · consultation_type="debitos-rn" · requires: input_data | |
| type = object · consultation_type="debitos-ro" · requires: input_data | |
| type = object · consultation_type="debitos-rr" · requires: input_data | |
| type = object · consultation_type="debitos-sc" · requires: input_data | |
| type = object · consultation_type="debitos-sp" · requires: input_data | |
| type = object · consultation_type="debitos-to" · requires: input_data | |
| type = object · consultation_type="enriquecimento-lead" · requires: input_data | |
| type = object · consultation_type="historico-profissional-renda" · requires: input_data | |
| type = object · consultation_type="inscricao-estadual-sp" · requires: input_data | |
| type = object · consultation_type="leniencia" · requires: input_data | |
| type = object · consultation_type="mapa-relacionamento-cnpj" · requires: input_data | |
| type = object · consultation_type="ofac-sancoes" · requires: input_data | |
| type = object · consultation_type="onu-sancoes" · requires: input_data | |
| type = object · consultation_type="orgaos-antt-transportador" · requires: input_data | |
| type = object · consultation_type="orgaos-antt-veiculo" · requires: input_data | |
| type = object · consultation_type="orgaos-der-pr" · requires: input_data | |
| type = object · consultation_type="orgaos-detran-sp-acompanhamento" · requires: input_data | |
| type = object · consultation_type="orgaos-medidor-velocidade" · requires: input_data | |
| type = object · consultation_type="orgaos-pge-sp" · requires: input_data | |
| type = object · consultation_type="orgaos-prf" · requires: input_data | |
| type = object · consultation_type="pep" · requires: input_data | |
| type = object · consultation_type="pessoas-veiculos" · requires: input_data | |
| type = object · consultation_type="pf-cnd-criminal" · requires: input_data | |
| type = object · consultation_type="pgfn-cnd-federal-cnpj" · requires: input_data | |
| type = object · consultation_type="pgfn-cnd-federal-cpf" · requires: input_data | |
| type = object · consultation_type="protestos-brasil" · requires: input_data | |
| type = object · consultation_type="sancoes-internacionais" · requires: input_data | |
| type = object · consultation_type="scr-bacen-analitico" · requires: input_data | |
| type = object · consultation_type="scr-bacen-resumo" · requires: input_data | |
| type = object · consultation_type="sit-trabalho-escravo" · requires: input_data | |
| type = object · consultation_type="situacao-cadastral-cpf" · requires: input_data | |
| type = object · consultation_type="tabela-fipe-placa" · requires: input_data | |
| type = object · consultation_type="tcu-consolidada-pj" · requires: input_data | |
| type = object · consultation_type="tcu-inabilitados" · requires: input_data | |
| type = object · consultation_type="tcu-inidoneos" · requires: input_data | |
| type = object · consultation_type="tst-cndt" · requires: input_data | |
| type = object · consultation_type="veiculos-base-nacional-v2" · requires: input_data | |
| type = object · consultation_type="veiculos-bin-estadual" · requires: input_data | |
| type = object · consultation_type="veiculos-cronotacografo" · requires: input_data | |
| type = object · consultation_type="veiculos-infracoes-v3" · requires: input_data |
consultation_typeConst value: antecedentes-cnpj
Entrada_antecedentes_cnpj · required
Executar uma consulta (forma longa) › Responses
A consulta foi aceita. Veja success para saber o desfecho.
oneOf
Exactly one variant must match.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: success, consultation_id, result | |
| type = object · requires: success, async, consultation_id +1 more | |
| type = object · requires: success, error, code |
successConst value:
consultation_idobject · required
O resultado da consulta.
environmentEnum values:
production
sandbox
balanceSaldo da carteira depois da cobrança.
remaining_unitsUnidades restantes, quando o pagamento saiu de um pacote.
idempotentPresente e true quando esta resposta repete uma chamada anterior, sem nova cobrança.
Acompanhar uma consulta assíncrona
GET
https://api.consultas.us
/status
Consulta o andamento pelo consultation_id devolvido no POST. Não cobra, pode ser chamado quantas vezes quiser.
Enquanto processa, a resposta traz apenas status: "processing" — não há resultado parcial. Quando termina, vem completed com o result, ou failed (e, se houve cobrança, ela é estornada).
query Parameters
consultation_idO identificador devolvido pelo POST.
Acompanhar uma consulta assíncrona › Responses
O estado atual da consulta.
successstatusEnum values:
processing
completed
failed
consultation_idobject
Presente quando completed.
errorPresente quando failed.
refundedQuanto foi estornado, quando houve cobrança.
Recuperar uma consulta já feita
GET
https://api.consultas.us
/lookup
Procura, no histórico da sua conta, uma consulta já realizada para aquele documento e produto. Não cobra e não executa nada novo.
query Parameters
typeO slug do produto.
documentO documento, com ou sem pontuação.
Recuperar uma consulta já feita › Responses
O que foi encontrado — ou a indicação de que não há nada.
successfoundSe havia consulta no histórico.
consultation_idobject