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

Schemas


Erro

success
​required
error
​string · required

Mensagem legível.

code
​string · enum · required

O código a usar para ramificar. É ele que é estável, não o texto.

Enum values:
MISSING_API_KEY
INVALID_API_KEY_FORMAT
INVALID_API_KEY
API_KEY_EXPIRED
ACCOUNT_BLOCKED
INVALID_BODY
INVALID_CONSULTATION_TYPE
CONSULTATION_TYPE_NOT_FOUND

RespostaSincrona

success
​const · required
Const value:
consultation_id
​string · uuid · required
​object · required

O resultado da consulta.

environment
​string · enum
Enum values:
production
sandbox
balance
​number | null

Saldo da carteira depois da cobrança.

remaining_units
​integer | null

Unidades restantes, quando o pagamento saiu de um pacote.

idempotent
​boolean

Presente e true quando esta resposta repete uma chamada anterior, sem nova cobrança.

RespostaAssincrona

A consulta foi aceita e segue em segundo plano. ⚠️ O status HTTP é **200**, não 202 — o que distingue este caso é o campo `async`.
success
​const · required
Const value:
async
​const · required
Const value:
consultation_id
​string · uuid · required
status
​const · required
Const value: processing
environment
​string · enum
Enum values:
production
sandbox

RespostaDeStatus

success
​boolean · required
status
​string · enum · required
Enum values:
processing
completed
failed
consultation_id
​string · uuid · required
​object

Presente quando completed.

error
​string

Presente quando failed.

refunded
​number | boolean | null

Quanto foi estornado, quando houve cobrança.

RespostaDeLookup

success
​boolean · required
found
​boolean

Se havia consulta no histórico.

consultation_id
​string | null · uuid
​object

ItemDeCatalogo

Um produto, como a sua conta o vê.
slug
​string

O identificador a enviar em consultation_type.

nome
​string
descricao
​string | null
categoria
​string | null
​object | null

O contrato de input_data.

lookup_field
​string | null

O campo que identifica o sujeito, quando há um.

preco_efetivo_brl
​number

O preço para a SUA conta, em reais.

liberado_para_este_tenant
​boolean
assincrono
​boolean

Quando true, o POST devolve async e o resultado sai por GET /status.

prazo_tipico
​string | null

RespostaDeCatalogo

success
​const · required
Const value:
total
​integer
has_more
​boolean
​ItemDeCatalogo[]

UnidadeDeSaldo

slug
​string | null
categoria
​string | null
unidades_restantes
​integer
expira_em
​string | null · date-time

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

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

Entrada_antecedentes_cnpj

cnpj
​string · br-cnpj · required

Entrada_antecedentes_cpf

cpf
​string · br-cpf · required

Entrada_cadastro_pf_completo

cpf
​string · br-cpf · required

Entrada_cadastro_pj_completo

cnpj
​string · br-cnpj · required

Entrada_cartao_cnpj

cnpj
​string · br-cnpj · required

Entrada_cartao_cpf

cpf
​string · br-cpf · required
birthdate
​string · date · required

Entrada_ceaf

cpf
​string · br-cpf · required

Entrada_ceis

documento
​string · br-documento · required

Entrada_cepim

cnpj
​string · br-cnpj · required

Entrada_certificado_de_seguranca_veicular_csv

placa
​string · br-placa · required
renavam
​number · required
documento
​string · br-documento · required

Entrada_cnep

documento
​string · br-documento · required

Entrada_cnh_completa

cpf
​string · br-cpf · required

Entrada_cnh_completa_v4

cpf
​string · br-cpf · required

Entrada_cnh_estadual_ac_completa

cpf
​string · br-cpf · required
nome
​string · required

Entrada_cnh_estadual_al_completa

cpf
​string · br-cpf · required
uf_nascimento
​string · required
data_nascimento
​string · date · required
cod_municipio_nascimento
​string · required

Entrada_cnh_estadual_am_completa

cnh
​string · required
cpf
​string · br-cpf · required

Entrada_cnh_estadual_ap_completa

cpf
​string · br-cpf · required
nome
​string · required
data_nascimento
​string · date · required

Entrada_cnh_estadual_ce_completa

cpf
​string · br-cpf · required
formulario
​string · required

Entrada_cnh_estadual_go_completa

cnh
​string · required

Entrada_cnh_estadual_ma_completa

cnh
​string · required
cpf
​string · br-cpf · required

Entrada_cnh_estadual_ms_completa

cnh
​string · required
cpf
​string · br-cpf · required

Entrada_cnh_estadual_mt_completa

cpf
​string · br-cpf · required
renach
​string · required

Entrada_cnh_estadual_pa_completa

cnh
​string · required
cpf
​string · br-cpf · required

Entrada_cnh_estadual_pr_completa

cnh
​string · required
cpf
​string · br-cpf · required
data_validade_cnh
​string · date · required

Entrada_cnh_estadual_pr_completa_v2

cnh
​string · required
cpf
​string · br-cpf · required
data_validade_cnh
​string · date · required

Entrada_cnh_estadual_rj_completa

cnh
​string · required
cpf
​string · br-cpf · required

Entrada_cnh_estadual_rn_completa

cnh
​string · required
cpf
​string · br-cpf · required

Entrada_cnh_estadual_se_completa

cnh
​string · required
registro
​string · required
data_nascimento
​string · date · required

Entrada_cnh_estadual_to_completa

cpf
​string · br-cpf · required
data_nascimento
​string · date · required

Entrada_cnh_foto

cpf
​string · br-cpf · required

Entrada_cnh_nacional_simples

cnh
​string · required
data_nascimento
​string · required

Entrada_cnj_improbidade

cpf
​string · br-cpf
cnpj
​string · br-cnpj
nome
​string
anyOf
At least one variant must match. Multiple variants may match simultaneously.

Decision Table

VariantMatching Criteria
type = object · requires: cpf
type = object · requires: cnpj
Properties for Variant 1:
cpf
​string · br-cpf · required
cnpj
​string · br-cnpj
nome
​string

Entrada_cnj_mandados_prisao

cpf
​string · br-cpf · required
nome
​string · required
nome_mae
​string

Entrada_consorcio

cpf
​string · br-cpf · required
birthdate
​string · date · required
nome
​string

Entrada_consulta_agregados

placa
​string · br-placa · required

Entrada_consulta_basica_de_veiculo

placa
​string · br-placa · required

Entrada_consulta_bin_nacional

placa
​string · br-placa · required

Entrada_consulta_cnpj

cnpj
​string · br-cnpj · required

Entrada_consulta_de_recall

placa
​string · br-placa · required

Entrada_consulta_de_roubo_e_furto

placa
​string · br-placa · required

Entrada_consulta_de_sinistro

placa
​string · br-placa · required

Entrada_consulta_nfe_chave

chave
​string · required

Entrada_consulta_processo_cnj

numero_cnj
​string · br-cnj · required

Entrada_credito_sintetico_pf

cpf
​string · br-cpf · required

Entrada_credito_sintetico_pj

cnpj
​string · br-cnpj · required

Entrada_debitos_ac

placa
​string · required
renavam
​string · required

Entrada_debitos_al

placa
​string · required
renavam
​string · required

Entrada_debitos_am

renavam
​string · required

Entrada_debitos_ap

placa
​string · required
renavam
​string · required

Entrada_debitos_ce

placa
​string · required
renavam
​string · required
documento
​string · br-documento · required

Entrada_debitos_df

placa
​string · required
renavam
​string · required

Entrada_debitos_ma

placa
​string · required
renavam
​string · required
documento
​string · br-documento · required

Entrada_debitos_mg_simples

placa
​string · required
renavam
​string · required

Entrada_debitos_ms

placa
​string · required
renavam
​string · required

Entrada_debitos_mt

placa
​string · required
renavam
​string · required
documento
​string · br-documento · required

Entrada_debitos_pa

placa
​string · br-placa · required
renavam
​string · br-renavam · required

Entrada_debitos_pb

placa
​string · br-placa · required
renavam
​string · br-renavam · required
documento
​string · br-documento · required

Entrada_debitos_pi

placa
​string · br-placa · required
renavam
​string · br-renavam · required

Entrada_debitos_pr

renavam
​string · br-renavam · required

Entrada_debitos_rj

placa
​string · br-placa · required
renavam
​string · br-renavam · required
documento
​string · br-documento · required

Entrada_debitos_rn

placa
​string · br-placa · required
renavam
​string · br-renavam · required

Entrada_debitos_ro

placa
​string · br-placa · required
renavam
​string · br-renavam · required
documento
​string · br-documento · required

Entrada_debitos_rr

placa
​string · br-placa · required
renavam
​string · br-renavam · required

Entrada_debitos_sc

placa
​string · br-placa · required
chassi
​string · required
renavam
​string · br-renavam · required

Entrada_debitos_sp

placa
​string · br-placa · required
renavam
​string · br-renavam · required

Entrada_debitos_to

placa
​string · br-placa · required
renavam
​string · br-renavam · required
documento
​string · br-documento · required

Entrada_enriquecimento_lead

email
​string
celular
​string

Entrada_historico_profissional_renda

cpf
​string · br-cpf · required

Entrada_inscricao_estadual_sp

cnpj
​string · br-cnpj · required

Entrada_leniencia

cnpj
​string · br-cnpj · required

Entrada_mapa_relacionamento_cnpj

documento
​string · br-cnpj · required

Entrada_ofac_sancoes

query
​string · required

Entrada_onu_sancoes

query
​string · required

Entrada_orgaos_antt_transportador

documento
​string · br-documento · required

Entrada_orgaos_antt_veiculo

placa
​string · br-placa · required
documento
​string · br-documento · required

Entrada_orgaos_der_pr

placa
​string · br-placa · required

Entrada_orgaos_detran_sp_acompanhamento

placa
​string · br-placa · required
renavam
​number · required
documento
​string · br-documento · required

Entrada_orgaos_medidor_velocidade

numero_inmetro
​string · required

Entrada_orgaos_pge_sp

renavam
​number · required

Entrada_orgaos_prf

placa
​string · br-placa · required
renavam
​number · required

Entrada_pep

cpf
​string · br-cpf · required
nome
​string

Entrada_pessoas_veiculos

documento
​string · br-documento · required

Entrada_pf_cnd_criminal

cpf
​string · br-cpf · required
nome
​string · required
nome_mae
​string · required
birthdate
​string · date · required
nome_pai
​string
uf_nascimento
​string · br-uf

Entrada_pgfn_cnd_federal_cnpj

cnpj
​string · br-cnpj · required

Entrada_pgfn_cnd_federal_cpf

cpf
​string · br-cpf · required
birthdate
​string · date · required

Entrada_protestos_brasil

cpf
​string · br-cpf
cnpj
​string · br-cnpj
anyOf
At least one variant must match. Multiple variants may match simultaneously.

Decision Table

VariantMatching Criteria
type = object · requires: cpf
type = object · requires: cnpj
Properties for Variant 1:
cpf
​string · br-cpf · required
cnpj
​string · br-cnpj

Entrada_sancoes_internacionais

query
​string · required

Entrada_scr_bacen_analitico

cpf
​string · br-cpf
cnpj
​string · br-cnpj
anyOf
At least one variant must match. Multiple variants may match simultaneously.

Decision Table

VariantMatching Criteria
type = object · requires: cpf
type = object · requires: cnpj
Properties for Variant 1:
cpf
​string · br-cpf · required
cnpj
​string · br-cnpj

Entrada_scr_bacen_resumo

cpf
​string · br-cpf
cnpj
​string · br-cnpj
anyOf
At least one variant must match. Multiple variants may match simultaneously.

Decision Table

VariantMatching Criteria
type = object · requires: cpf
type = object · requires: cnpj
Properties for Variant 1:
cpf
​string · br-cpf · required
cnpj
​string · br-cnpj

Entrada_sit_trabalho_escravo

cpf
​string · br-cpf
cnpj
​string · br-cnpj
anyOf
At least one variant must match. Multiple variants may match simultaneously.

Decision Table

VariantMatching Criteria
type = object · requires: cpf
type = object · requires: cnpj
Properties for Variant 1:
cpf
​string · br-cpf · required
cnpj
​string · br-cnpj

Entrada_situacao_cadastral_cpf

cpf
​string · br-cpf · required
data_nascimento
​string · date · required

Entrada_tabela_fipe_placa

placa
​string · br-placa · required

Entrada_tcu_consolidada_pj

cnpj
​string · br-cnpj · required

Entrada_tcu_inabilitados

cpf
​string · br-cpf · required

Entrada_tcu_inidoneos

cpf
​string · br-cpf
cnpj
​string · br-cnpj
anyOf
At least one variant must match. Multiple variants may match simultaneously.

Decision Table

VariantMatching Criteria
type = object · requires: cpf
type = object · requires: cnpj
Properties for Variant 1:
cpf
​string · br-cpf · required
cnpj
​string · br-cnpj

Entrada_tst_cndt

cpf
​string · br-cpf
cnpj
​string · br-cnpj
anyOf
At least one variant must match. Multiple variants may match simultaneously.

Decision Table

VariantMatching Criteria
type = object · requires: cpf
type = object · requires: cnpj
Properties for Variant 1:
cpf
​string · br-cpf · required
cnpj
​string · br-cnpj

Entrada_veiculos_base_nacional_v2

placa
​string · br-placa · required

Entrada_veiculos_bin_estadual

placa
​string · br-placa · required

Entrada_veiculos_cronotacografo

placa
​string · br-placa · required

Entrada_veiculos_infracoes_v3

placa
​string · br-placa · required
On this page
  • Erro
  • RespostaSincrona
  • RespostaAssincrona
  • RespostaDeStatus
  • RespostaDeLookup
  • ItemDeCatalogo
  • RespostaDeCatalogo
  • UnidadeDeSaldo
  • RespostaDeSaldo
  • RespostaDeOrcamento
  • Entrada_antecedentes_cnpj
  • Entrada_antecedentes_cpf
  • Entrada_cadastro_pf_completo
  • Entrada_cadastro_pj_completo
  • Entrada_cartao_cnpj
  • Entrada_cartao_cpf
  • Entrada_ceaf
  • Entrada_ceis
  • Entrada_cepim
  • Entrada_certificado_de_seguranca_veicular_csv
  • Entrada_cnep
  • Entrada_cnh_completa
  • Entrada_cnh_completa_v4
  • Entrada_cnh_estadual_ac_completa
  • Entrada_cnh_estadual_al_completa
  • Entrada_cnh_estadual_am_completa
  • Entrada_cnh_estadual_ap_completa
  • Entrada_cnh_estadual_ce_completa
  • Entrada_cnh_estadual_go_completa
  • Entrada_cnh_estadual_ma_completa
  • Entrada_cnh_estadual_ms_completa
  • Entrada_cnh_estadual_mt_completa
  • Entrada_cnh_estadual_pa_completa
  • Entrada_cnh_estadual_pr_completa
  • Entrada_cnh_estadual_pr_completa_v2
  • Entrada_cnh_estadual_rj_completa
  • Entrada_cnh_estadual_rn_completa
  • Entrada_cnh_estadual_se_completa
  • Entrada_cnh_estadual_to_completa
  • Entrada_cnh_foto
  • Entrada_cnh_nacional_simples
  • Entrada_cnj_improbidade
  • Entrada_cnj_mandados_prisao
  • Entrada_consorcio
  • Entrada_consulta_agregados
  • Entrada_consulta_basica_de_veiculo
  • Entrada_consulta_bin_nacional
  • Entrada_consulta_cnpj
  • Entrada_consulta_de_recall
  • Entrada_consulta_de_roubo_e_furto
  • Entrada_consulta_de_sinistro
  • Entrada_consulta_nfe_chave
  • Entrada_consulta_processo_cnj
  • Entrada_credito_sintetico_pf
  • Entrada_credito_sintetico_pj
  • Entrada_debitos_ac
  • Entrada_debitos_al
  • Entrada_debitos_am
  • Entrada_debitos_ap
  • Entrada_debitos_ce
  • Entrada_debitos_df
  • Entrada_debitos_ma
  • Entrada_debitos_mg_simples
  • Entrada_debitos_ms
  • Entrada_debitos_mt
  • Entrada_debitos_pa
  • Entrada_debitos_pb
  • Entrada_debitos_pi
  • Entrada_debitos_pr
  • Entrada_debitos_rj
  • Entrada_debitos_rn
  • Entrada_debitos_ro
  • Entrada_debitos_rr
  • Entrada_debitos_sc
  • Entrada_debitos_sp
  • Entrada_debitos_to
  • Entrada_enriquecimento_lead
  • Entrada_historico_profissional_renda
  • Entrada_inscricao_estadual_sp
  • Entrada_leniencia
  • Entrada_mapa_relacionamento_cnpj
  • Entrada_ofac_sancoes
  • Entrada_onu_sancoes
  • Entrada_orgaos_antt_transportador
  • Entrada_orgaos_antt_veiculo
  • Entrada_orgaos_der_pr
  • Entrada_orgaos_detran_sp_acompanhamento
  • Entrada_orgaos_medidor_velocidade
  • Entrada_orgaos_pge_sp
  • Entrada_orgaos_prf
  • Entrada_pep
  • Entrada_pessoas_veiculos
  • Entrada_pf_cnd_criminal
  • Entrada_pgfn_cnd_federal_cnpj
  • Entrada_pgfn_cnd_federal_cpf
  • Entrada_protestos_brasil
  • Entrada_sancoes_internacionais
  • Entrada_scr_bacen_analitico
  • Entrada_scr_bacen_resumo
  • Entrada_sit_trabalho_escravo
  • Entrada_situacao_cadastral_cpf
  • Entrada_tabela_fipe_placa
  • Entrada_tcu_consolidada_pj
  • Entrada_tcu_inabilitados
  • Entrada_tcu_inidoneos
  • Entrada_tst_cndt
  • Entrada_veiculos_base_nacional_v2
  • Entrada_veiculos_bin_estadual
  • Entrada_veiculos_cronotacografo
  • Entrada_veiculos_infracoes_v3