--- title: "Base Estadual" description: "Realiza uma busca abrangente em bancos de dados estaduais, consolidando informações de diversas fontes para fornecer um panorama completo do veículo em âmbito estadual" lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/pY925c7a9-ecaf-21b7-a765-99b6741f62 markdown: https://doc.apibrasil.io/apis/creditos/pY925c7a9-ecaf-21b7-a765-99b6741f62.md source: apibrasil-documentation --- # Base Estadual > Realiza uma busca abrangente em bancos de dados estaduais, consolidando informações de diversas fontes para fornecer um panorama completo do veículo em âmbito estadual - **Categoria:** Segurança Veicular - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 2,50 por consulta - **Limite:** 990.000 por mês - **Cadastro:** exige CNPJ - **Versão:** v2 - **Publicada por:** APIBrasil - **Especificação OpenAPI:** https://doc.apibrasil.io/apis/creditos/pY925c7a9-ecaf-21b7-a765-99b6741f62/openapi.json ## Como chamar **Endereço base:** `https://gateway.apibrasil.io/api/v2` Autenticação: cabeçalho `Authorization: Bearer `. Nada além disso. Com `homolog: true` no corpo, o gateway responde de uma base fixa, com a forma real da resposta, e não cobra. O CPF 00000000000 é dessa base e não é de ninguém: use-o nos testes, nunca em produção. ## Endpoints (1 endpoint) ### 1. POST /consulta/veiculos/credits API Veicular — Consulta Estadual Consolidada por Placa A API Veicular realiza uma busca abrangente em bancos de dados estaduais, reunindo informações de diversas fontes para fornecer um panorama completo da situação do veículo em nível estadual. O retorno apresenta dados técnicos, cadastrais, restrições ativas, pendências financeiras e administrativas, além de mensagens informativas relacionadas ao histórico do veículo. - **Método:** `POST` - **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/veiculos/credits` - **Versão da rota:** v2 **Cabeçalhos** | Cabeçalho | Valor | | --- | --- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer $APIBRASIL_TOKEN` | **Corpo da requisição** ```json { "tipo": "estadual", "placa": "QOZ7702", "homolog": true } ``` **Em cURL** ```bash curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/veiculos/credits" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $APIBRASIL_TOKEN" \ -d '{"tipo":"estadual","placa":"QOZ7702","homolog":true}' ``` Este endpoint aceita `homolog: true` no corpo: a resposta volta com dados válidos, `api_limit_for` igual a `homolog` e sem tarifação. **Resposta de exemplo, do catálogo** ```json { "user": { "first_name": "[omitido]", "email": "[omitido]", "cellphone": "[omitido]", "notification": "yes" }, "balance": "248,660", "balance_before": "248,660", "tax": "0,000", "status_code": 200, "error": false, "message": "Dados validos em homologacao! Voce nao foi tarifado e a requisicao nao foi contabilizada.", "valor_consulta": 0, "api_limit_for": "homolog", "homolog": true, "data": { "bin_estadual": { "alerta_informativo": "Consulta de homologacao - dados simulados", "ano_fabricacao": "2024", "ano_modelo": "2025", "caixa_cambio": "", "capacidade_carga": "1500", "categoria_veiculo": "PARTICULAR", "chassi": "9ZX0H0M0L0G4T001X", "cilindrada": "1600", "cmt": "", "codigo_seguranca_crv": "1234567890", "combustivel": "GASOLINA", "cor_veiculo": "AZUL", "data_atualizacao": "15/05/2024", "data_emissao_crlv": "10/05/2024", "data_emissao_ultimo_crv": "09/05/2024", "data_emplacamento": "20/01/2024", "data_limite_restricao_tributaria": "", "especie_veiculo": "PASSAGEIRO", "informacoes_avulsas": [ { "codigo": "H001", "descricao": "Consulta em ambiente de homologacao", "valor": "DADOS SIMULADOS" }, { "codigo": "H002", "descricao": "Comprovante ficticio", "valor": "http://api-base-estadual-v2.apiveiculos.com.br/pdf/mockpdf" } ], "marca_modelo": "MONTADORA/PROTO HOMOLOG", "municipio": "CIDADE HOMOLOG", "nome_carroceria": "", "numero_carroceria": "", "numero_crv": "0000000000", "numero_eixo_auxiliar": "", "numero_eixo_traseiro": "", "numero_eixos": "", "numero_identificacao_do_faturado": "", "numero_motor": "H0M0LG1234", "numero_sequencia_crv": "001", "numero_via_crlv": "01", "numero_via_crv": "01", "off_line": "0", "pbt": "1500", "placa": "QOZ7702", "potencia_veiculo": "110", "procedencia": "NACIONAL", "proprietario": { "documento": "000.000.000-00", "nome": "USUARIO HOMOLOG" }, "quantidade_passageiros": "005", "renavam": "00000000000", "restricoes": { "dpvat": { "existe_pendencia": "0", "observacoes": "", "valor_pendencia": "0,00" }, "existe_restricao_financiamento": "0", "existe_restricao_geral": "0", "existe_restricao_renajud": "0", "existe_restricao_roubo_furto": "0", "financiamento": { "cgc_financeira": "", "codigo_agente": "", "cpf_cnpj_financiado": "", "data_inclusao": "", "data_vigencia_contrato": "", "nome_agente_financeiro": "", "nome_financiado": "", "numero_contrato": "", "tipo_restricao_financiamento": "", "tipo_transacao": "" }, "ipva": { "existe_pendencia": "0", "observacoes": "", "valor_pendencia": "0,00" }, "licenciamento": { "existe_pendencia": "0", "observacoes": "", "valor_pendencia": "0,00" }, "mensagens_restricoes": [ { "mensagem": "Retorno de homologacao com dados simulados" }, { "mensagem": "Sem impactos financeiros reais" } ], "multas": { "existe_pendencia": "0", "observacoes": "", "valor_pendencia": "0,00" }, "veiculo_baixado": "0" }, "situacao": "EM CIRCULACAO", "situacao_chassi": "REGULAR", "status_retorno": { "codigo": "1", "descricao": "CONSULTA CONCLUIDA COM SUCESSO" }, "tipo_carroceria": "NAO INFORMADO", "tipo_documento_do_faturado": "", "tipo_montagem": "", "tipo_veiculo": "AUTOMOVEL", "uf": "PR", "uf_destino_de_faturamento": "" } } } ``` Nos exemplos de resposta, os campos da conta que gerou o exemplo (`user.first_name`, `user.email`, `user.cellphone`) saem como `[omitido]`. O resto é o que o catálogo publica. ## Armadilhas: o que uma integração erra sem avisar Apuradas nas respostas que o próprio catálogo publica. Em todas elas o código funciona no caminho feliz e falha em silêncio no resto: 1. **O erro chega no CORPO, com HTTP 200.** A resposta traz um campo `error` booleano e uma `message`. Checar só `response.ok` ou o status HTTP deixa passar falha como sucesso. Confira SEMPRE `error === false` antes de ler `data`. 2. **`balance`, `tax` e `extra_charges.total` são STRING em formato brasileiro — e o formato varia entre APIs.** Valores observados no catálogo: `"154,380"`, `"497,84"`, `"0,000"` e `"0.19"`. Vírgula em umas, ponto em outra; três casas decimais em umas, duas em outra. Em JavaScript, `parseFloat("154,380")` devolve `154` e perde os centavos sem erro nenhum, e `Number("154,380")` devolve `NaN`. Escreva um conversor que trate os dois separadores, e nunca use esses campos numa decisão financeira sem convertê-los. 3. **Cada chamada custa dinheiro.** Retry cego multiplica a conta. Nunca repita automaticamente um 4xx: parâmetro errado repetido continua errado e continua cobrando. Repita só tempo esgotado e 5xx, com recuo exponencial e um teto pequeno de tentativas. 4. **HTTP 402 é saldo insuficiente, e repetir não resolve.** É o único status que exige ação humana — recarregar. Trate-o como erro terminal, com mensagem própria, e não o jogue no mesmo balde dos 4xx genéricos. 5. **`extra_charges` cobra à parte do preço da consulta.** Quando o corpo pede serviços adicionais, a resposta traz cada um com o preço e um `total` que NÃO está incluso no valor base. Se você mostra custo a quem usa, some os dois. ## Ver também - Especificação OpenAPI: https://doc.apibrasil.io/apis/creditos/pY925c7a9-ecaf-21b7-a765-99b6741f62/openapi.json - Catálogo de APIs: [Catálogo de APIs](https://doc.apibrasil.io/apis.md) - SDKs oficiais: [SDKs oficiais](https://doc.apibrasil.io/sdks.md) - Índice da documentação: https://doc.apibrasil.io/llms.txt - Versão HTML desta página: https://doc.apibrasil.io/apis/creditos/pY925c7a9-ecaf-21b7-a765-99b6741f62