API AutoConsulta
requiredstring · requiredstring · enum · requiredconst · requiredstring · uuid · requiredstring · enumnumber | nullinteger | nullboolean const · requiredconst · requiredstring · uuid · requiredconst · requiredstring · enumboolean · requiredstring · enum · requiredstring · uuid · requiredstringnumber | boolean | nullboolean · requiredbooleanstring | null · uuid stringstringstring | nullstring | nullstring | nullnumberbooleanbooleanstring | nullstring | nullstring | nullintegerstring | null · date-timeconst · requiredstring · enum · requiredconst · requiredstring · requirednumber · requiredstring | nullboolean | nullbooleanboolean | nullstring · br-placa · requirednumber · requiredstring · br-documento · requiredstring · br-cpf · requiredstring · requiredstring · date · requiredstring · requiredstring · br-cpf · requiredstring · requiredstring · date · requiredstring · requiredstring · br-cpf · requiredstring · date · requiredstring · requiredstring · br-cpf · requiredstring · date · requiredstring · requiredstring · requiredstring · date · requiredstring · br-cpf · requiredstring · date · requiredstring · br-cpfstring · br-cnpjstring
Properties for Variant 1:string · br-cpf · requiredstring · br-cnpjstringstring · requiredstring · requiredstring · br-documento · requiredstring · requiredstring · requiredstring · br-documento · requiredstring · requiredstring · requiredstring · br-documento · requiredstring · br-placa · requiredstring · br-renavam · requiredstring · br-documento · requiredstring · br-placa · requiredstring · br-renavam · requiredstring · br-documento · requiredstring · br-placa · requiredstring · br-renavam · requiredstring · br-documento · requiredstring · br-placa · requiredstring · requiredstring · br-renavam · requiredstring · br-placa · requiredstring · br-renavam · requiredstring · br-documento · requiredstring · br-placa · requiredstring · br-documento · requiredstring · br-placa · requirednumber · requiredstring · br-documento · requiredstring · br-cpf · requiredstring · requiredstring · requiredstring · date · requiredstringstring · br-ufstring · br-cpfstring · br-cnpj
Properties for Variant 1:string · br-cpf · requiredstring · br-cnpjstring · br-cpfstring · br-cnpj
Properties for Variant 1:string · br-cpf · requiredstring · br-cnpjstring · br-cpfstring · br-cnpj
Properties for Variant 1:string · br-cpf · requiredstring · br-cnpjstring · br-cpfstring · br-cnpj
Properties for Variant 1:string · br-cpf · requiredstring · br-cnpjstring · br-cpf · requiredstring · date · requiredstring · br-cpfstring · br-cnpj
Properties for Variant 1:string · br-cpf · requiredstring · br-cnpjstring · br-cpfstring · br-cnpj
Properties for Variant 1:string · br-cpf · requiredstring · br-cnpj
Schemas
Erro
successerrorMensagem legível.
codeO 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
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.
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`.
successConst value:
asyncConst value:
consultation_idstatusConst value: processing
environmentEnum values:
production
sandbox
RespostaDeStatus
successstatusEnum values:
processing
completed
failed
consultation_idobject
Presente quando completed.
errorPresente quando failed.
refundedQuanto foi estornado, quando houve cobrança.
RespostaDeLookup
successfoundSe havia consulta no histórico.
consultation_idobject
ItemDeCatalogo
Um produto, como a sua conta o vê.
slugO identificador a enviar em consultation_type.
nomedescricaocategoriaobject | null
O contrato de input_data.
lookup_fieldO campo que identifica o sujeito, quando há um.
preco_efetivo_brlO preço para a SUA conta, em reais.
liberado_para_este_tenantassincronoQuando true, o POST devolve async e o resultado sai por GET /status.
prazo_tipicoUnidadeDeSaldo
slugcategoriaunidades_restantesexpira_emRespostaDeSaldo
successConst value:
modoEnum values:
pre_pago
pos_pago
RespostaDeOrcamento
successConst value:
slugpreco_efetivo_brlfonte_de_pagamento_previstaDe onde o pagamento sairia.
saldo_suficienteliberadoja_no_historicoSe aquele documento já foi consultado. null quando não dá para saber.
object
Entrada_certificado_de_seguranca_veicular_csv
placarenavamdocumentoEntrada_cnh_estadual_al_completa
cpfuf_nascimentodata_nascimentocod_municipio_nascimentoEntrada_cnh_estadual_ap_completa
cpfnomedata_nascimentoEntrada_cnh_estadual_pr_completa
cnhcpfdata_validade_cnhEntrada_cnh_estadual_pr_completa_v2
cnhcpfdata_validade_cnhEntrada_cnh_estadual_se_completa
cnhregistrodata_nascimentoEntrada_cnh_estadual_to_completa
cpfdata_nascimentoEntrada_cnj_improbidade
cpfcnpjnomeanyOf
At least one variant must match. Multiple variants may match simultaneously.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: cpf | |
| type = object · requires: cnpj |
cpfcnpjnomeEntrada_debitos_ce
placarenavamdocumentoEntrada_debitos_ma
placarenavamdocumentoEntrada_debitos_mt
placarenavamdocumentoEntrada_debitos_pb
placarenavamdocumentoEntrada_debitos_rj
placarenavamdocumentoEntrada_debitos_ro
placarenavamdocumentoEntrada_debitos_sc
placachassirenavamEntrada_debitos_to
placarenavamdocumentoEntrada_orgaos_antt_veiculo
placadocumentoEntrada_orgaos_detran_sp_acompanhamento
placarenavamdocumentoEntrada_pf_cnd_criminal
cpfnomenome_maebirthdatenome_paiuf_nascimentoEntrada_protestos_brasil
cpfcnpjanyOf
At least one variant must match. Multiple variants may match simultaneously.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: cpf | |
| type = object · requires: cnpj |
cpfcnpjEntrada_scr_bacen_analitico
cpfcnpjanyOf
At least one variant must match. Multiple variants may match simultaneously.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: cpf | |
| type = object · requires: cnpj |
cpfcnpjEntrada_scr_bacen_resumo
cpfcnpjanyOf
At least one variant must match. Multiple variants may match simultaneously.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: cpf | |
| type = object · requires: cnpj |
cpfcnpjEntrada_sit_trabalho_escravo
cpfcnpjanyOf
At least one variant must match. Multiple variants may match simultaneously.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: cpf | |
| type = object · requires: cnpj |
cpfcnpjEntrada_situacao_cadastral_cpf
cpfdata_nascimentoEntrada_tcu_inidoneos
cpfcnpjanyOf
At least one variant must match. Multiple variants may match simultaneously.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: cpf | |
| type = object · requires: cnpj |
cpfcnpjEntrada_tst_cndt
cpfcnpjanyOf
At least one variant must match. Multiple variants may match simultaneously.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: cpf | |
| type = object · requires: cnpj |
cpfcnpj