API AutoConsulta
  • Começar
  • Servidor MCP
  • Referência da API
Information
Consultas
    Executar uma consultapostExecutar uma consulta (forma longa)postAcompanhar uma consulta assíncronagetRecuperar uma consulta já feitaget
Catálogo
    Listar os produtos disponíveis para a sua contaget
Conta
    Consultar o saldo da contagetOrçar uma consulta antes de executá-lapost
Serviço
    Verificar se o serviço está no arget
Schemas
powered by Zudoku
API AutoConsulta
API AutoConsulta

Conta

Saldo e orçamento.


Consultar o saldo da conta

GET
https://api.consultas.us
/balance

Devolve o saldo da carteira, o modo de cobrança e as unidades de pacotes e cortesias ainda válidas. Não cobra.

Consultar o saldo da conta › Responses

O saldo atual.

RespostaDeSaldo
success
​const · required
Const value:
modo
​string · enum · required
Enum values:
pre_pago
pos_pago
saldo_brl
​number
limite_credito_brl
​number | null
​UnidadeDeSaldo[]
​UnidadeDeSaldo[]
GET/balance
curl https://api.consultas.us/balance \ --header 'X-API-Key: <api-key>'
Example Responses
{ "success": true, "modo": "pre_pago", "saldo_brl": 0, "limite_credito_brl": 0, "pacotes": [ { "slug": "slug", "categoria": "categoria", "unidades_restantes": 0, "expira_em": "2024-08-25T15:00:00Z" } ], "cortesias": [ { "slug": "slug", "categoria": "categoria", "unidades_restantes": 0, "expira_em": "2024-08-25T15:00:00Z" } ] }
json
application/json

Orçar uma consulta antes de executá-la

POST
https://api.consultas.us
/estimate

Diz quanto uma consulta custaria, de onde ela sairia (carteira, pacote ou cortesia), se a entrada está completa e se aquele documento já está no seu histórico. Não cobra e não executa nada.

Orçar uma consulta antes de executá-la › Request Body

oneOf
Exactly one variant must match.

Decision Table

VariantMatching 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
Properties for Antecedentes Judicial CNPJ:
consultation_type
​const · required
Const value: antecedentes-cnpj
​Entrada_antecedentes_cnpj · required

Orçar uma consulta antes de executá-la › Responses

O orçamento.

RespostaDeOrcamento
success
​const · required
Const value:
slug
​string · required
preco_efetivo_brl
​number · required
fonte_de_pagamento_prevista
​string | null

De onde o pagamento sairia.

saldo_suficiente
​boolean | null
liberado
​boolean
ja_no_historico
​boolean | null

Se aquele documento já foi consultado. null quando não dá para saber.

​object
POST/estimate
curl https://api.consultas.us/estimate \ --request POST \ --header 'Content-Type: application/json' \ --header 'X-API-Key: <api-key>' \ --data '{ "consultation_type": "antecedentes-cnpj", "input_data": { "cnpj": "cnpj" } }'
Example Request Body
{ "consultation_type": "antecedentes-cnpj", "input_data": { "cnpj": "cnpj" } }
json
Example Responses
{ "success": true, "slug": "slug", "preco_efetivo_brl": 0, "fonte_de_pagamento_prevista": "fonte_de_pagamento_prevista", "saldo_suficiente": true, "liberado": true, "ja_no_historico": true, "validacao": { "ok": true, "campos_faltando": [ "string" ], "formatos": {}, "mensagem": "mensagem" } }
json
application/json

CatálogoServiço