---
title: "Base Estadual V3 Assíncrona"
description: "API Base Estadual V3 Assíncrona - Respostas rápidas e pague só pelo sucesso"
lang: en
canonical: https://doc.apibrasil.io/apis/creditos/4091e178-3517-405e-b1f6-8516c042d530
markdown: https://doc.apibrasil.io/apis/creditos/4091e178-3517-405e-b1f6-8516c042d530.md
source: apibrasil-documentation
---

# Base Estadual V3 Assíncrona

> API Base Estadual V3 Assíncrona - Respostas rápidas e pague só pelo sucesso

- **Category:** Asynchronous Lookups
- **Billing:** per query, with the Bearer Token only
- **Price:** R$10.75 per query
- **Limit:** 999,000 per month
- **Registration:** requires a CNPJ
- **Version:** v1
- **Published by:** APIBrasil
- **OpenAPI specification:** https://doc.apibrasil.io/apis/creditos/4091e178-3517-405e-b1f6-8516c042d530/openapi.json

⚠ This API does not serve in production yet, only in the sandbox.

## How to call

**Base address:** `https://gateway.apibrasil.io/api/v2`

Authentication: the `Authorization: Bearer <token>` header. Nothing else.

With `homolog: true` in the body, the gateway answers from a fixed base, with the real shape of the response, and does not charge. The CPF 00000000000 belongs to that base and to nobody: use it in tests, never in production.

## Endpoints (2 endpoints)

### 1. POST /consulta/vehicles/credits

API Veicular Estadual - Consulta Assíncrona da Base Estadual por Placa

A API Base Estadual V3 Assíncrona dispara a consulta dos dados cadastrais estaduais do veículo pela placa através do endpoint POST consulta/vehicles/credits e entrega o resultado no seu webhook_url. Com integração rápida ao seu sistema, você obtém respostas estruturadas e de fácil interpretação, otimizando processos como análise de crédito, compliance fiscal e gestão de ativos automotivos. Potencialize sua operação ao acessar informações essenciais para tomadas de decisão estratégicas, reduzindo custos operacionais e elevando o valor do seu negócio com dados confiáveis e atualizados em tempo real.

- **Method:** `POST`
- **Address:** `https://gateway.apibrasil.io/api/v2/consulta/vehicles/credits`
- **Route version:** v1

**Headers**

| Header | Value |
| --- | --- |
| `Content-Type` | `application/json` |
| `Authorization` | `Bearer $APIBRASIL_TOKEN` |

**Request body**

```json
{
  "tipo": "base-estadual-v3-async",
  "placa": "ABC1234",
  "webhook_url": "https://webhook.site/seu-id",
  "homolog": true
}
```

**In cURL**

```bash
curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/vehicles/credits" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $APIBRASIL_TOKEN" \
  -d '{"tipo":"base-estadual-v3-async","placa":"ABC1234","webhook_url":"https://webhook.site/seu-id","homolog":true}'
```

This endpoint accepts `homolog: true` in the body: the response comes back with valid data, `api_limit_for` equal to `homolog` and no charge.

**Sample response, from the catalog**

```json
{
  "user": {
    "first_name": "[omitido]",
    "email": "[omitido]",
    "cellphone": "[omitido]",
    "notification": "yes"
  },
  "balance": "820,150",
  "balance_before": "820,150",
  "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": {
    "accepted": true,
    "job-id": "a39c209e-db73-44ec-b6bf-af38a350b7fb",
    "msg": "consulta em processamento; resultado sera enviado ao webhook_url"
  }
}
```

### 2. POST /consulta/vehicles/credits

API Veicular - Resultado da Consulta Estadual pelo Job ID

A Base Estadual V3 Assíncrona permite integrar rapidamente a consulta assíncrona da base estadual de veículos ao seu sistema, otimizando fluxos operacionais e facilitando tomadas de decisão precisas. Com apenas um POST para o endpoint consulta/vehicles/credits, você pode acompanhar o status das requisições via Job ID, garantindo controle total do processo. O retorno detalhado da API oferece os dados cadastrais estaduais do veículo para validação cadastral e automação de processos, agregando valor imediato ao seu negócio. Potencialize sua plataforma com consulta escalável, segura e alinhada à inovação do mercado automotivo.

- **Method:** `POST`
- **Address:** `https://gateway.apibrasil.io/api/v2/consulta/vehicles/credits`
- **Route version:** v1

**Headers**

| Header | Value |
| --- | --- |
| `Content-Type` | `application/json` |
| `Authorization` | `Bearer $APIBRASIL_TOKEN` |

**Request body**

```json
{
  "tipo": "consultar-chave-base-estadual-v3",
  "job-id": "a39c209e-db73-44ec-b6bf-af38a350b7fb",
  "homolog": true
}
```

**In cURL**

```bash
curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/vehicles/credits" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $APIBRASIL_TOKEN" \
  -d '{"tipo":"consultar-chave-base-estadual-v3","job-id":"a39c209e-db73-44ec-b6bf-af38a350b7fb","homolog":true}'
```

This endpoint accepts `homolog: true` in the body: the response comes back with valid data, `api_limit_for` equal to `homolog` and no charge.

The catalog does not publish a sample response for this endpoint.

In the sample responses, the fields of the account that generated the sample (`user.first_name`, `user.email`, `user.cellphone`) come out as `[omitido]`. The rest is what the catalog publishes.

## Pitfalls: what an integration gets wrong without warning

Established from the responses the catalog itself publishes. In every one of them the code works on the happy path and fails silently everywhere else:

1. **The error arrives in the BODY, with HTTP 200.**
   The response carries a boolean `error` field and a `message`. Checking only `response.ok` or the HTTP status lets a failure through as a success. ALWAYS check `error === false` before reading `data`.

2. **`balance`, `tax` and `extra_charges.total` are STRINGS in Brazilian format — and the format varies between APIs.**
   Values seen in the catalog: `"154,380"`, `"497,84"`, `"0,000"` and `"0.19"`. Comma in some, dot in another; three decimal places in some, two in another. In JavaScript, `parseFloat("154,380")` returns `154` and drops the cents with no error at all, and `Number("154,380")` returns `NaN`. Write a converter that handles both separators, and never use these fields in a financial decision without converting them.

3. **Every call costs money.**
   Blind retries multiply the bill. Never automatically repeat a 4xx: a bad parameter repeated is still bad, and still charged. Retry only timeouts and 5xx, with exponential backoff and a small attempt ceiling.

4. **HTTP 402 means insufficient balance, and retrying does not fix it.**
   It is the one status that needs a human — a top-up. Treat it as a terminal error with its own message, and do not lump it in with generic 4xx.

5. **`extra_charges` bills on top of the lookup price.**
   When the body asks for add-on services, the response lists each one with its price plus a `total` that is NOT included in the base amount. If you show cost to an end user, add both.

## See also

- OpenAPI specification: https://doc.apibrasil.io/apis/creditos/4091e178-3517-405e-b1f6-8516c042d530/openapi.json
- API catalog: [API catalog](https://doc.apibrasil.io/apis.md)
- Official SDKs: [Official SDKs](https://doc.apibrasil.io/sdks.md)
- Documentation index: https://doc.apibrasil.io/llms.txt
- HTML version of this page: https://doc.apibrasil.io/apis/creditos/4091e178-3517-405e-b1f6-8516c042d530