--- title: "Débitos V4 Assíncrona" description: "⚠️ Aviso: Esta consulta será debitada assim que o processamento assíncrono for concluído." lang: en canonical: https://doc.apibrasil.io/apis/creditos/9f74da75-5123b-4f3b-9533-cc7e9a5gf24 markdown: https://doc.apibrasil.io/apis/creditos/9f74da75-5123b-4f3b-9533-cc7e9a5gf24.md source: apibrasil-documentation --- # Débitos V4 Assíncrona > ⚠️ Aviso: Esta consulta será debitada assim que o processamento assíncrono for concluído. - **Category:** Asynchronous Lookups - **Billing:** per query, with the Bearer Token only - **Price:** R$8.00 per query - **Limit:** 9,990,000 per month - **Registration:** requires a CNPJ - **Version:** v1 - **Published by:** APIBrasil - **OpenAPI specification:** https://doc.apibrasil.io/apis/creditos/9f74da75-5123b-4f3b-9533-cc7e9a5gf24/openapi.json ## How to call **Base address:** `https://gateway.apibrasil.io/api/v2` Authentication: the `Authorization: Bearer ` 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 ⚠️ Aviso: Esta consulta será debitada assim que o processamento assíncrono for concluído. API Débitos Veiculares - Consulta Ágil e Segura A API Débitos V4 Assíncrona permite que seu sistema consulte rapidamente eventuais débitos veiculares de forma 100% online e segura, trazendo respostas detalhadas e atualizadas via método POST no endpoint /consulta/vehicles/credits. Ideal para empresas de crédito, fintechs, despachantes e plataformas de gestão veicular, a integração é simples e acelera processos internos, agregando valor imediato ao seu negócio. Adote uma solução confiável e automatize a checagem de pendências em veículos para tomada de decisões mais precisas, reduzindo riscos e melhorando a experiência do seu cliente. - **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": "debitos-v4-async", "placa": "ABC1234", "webhook_url": "https://seu-webhook.com.br", "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":"debitos-v4-async","placa":"ABC1234","webhook_url":"https://seu-webhook.com.br","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": "514,780", "balance_before": "514,780", "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": "3309cfc2-3ab5-4dbe-a1bc-5bc2afa6c7d9", "msg": "consulta em processamento; resultado será enviado ao webhook_url" } } ``` ### 2. POST /consulta/vehicles/credits ⚠️ Aviso: A chave para utilizar essa consulta tem validade de 24 horas. API Débitos Veiculares - Consulta Ágil para Decisões Rápidas A API Débitos V4 Assíncrona permite que seu sistema consulte em tempo real os débitos veiculares (multas, impostos e pendências) de maneira prática e totalmente integrada. Com integração rápida via POST no endpoint de consulta/vehicles/credits, você adiciona eficiência ao seu fluxo e aumenta a confiança nas decisões comerciais, como financiamentos, comercialização de veículos e gestão de frota. Receba retornos claros e completos, prontos para serem aproveitados em análises automáticas e conferências instantâneas, tudo acompanhado por robustez técnica e escalabilidade para o seu negócio. - **Method:** `POST` - **Address:** `https://gateway.apibrasil.io/api/v2/consulta/vehicles/credits` - **Route version:** v1 - **Price of this operation:** R$0.00 per query **Headers** | Header | Value | | --- | --- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer $APIBRASIL_TOKEN` | **Request body** ```json { "tipo": "consulta-chave", "job-id": "e312f471-b548-43c7-bdea-66f371a02045", "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":"consulta-chave","job-id":"e312f471-b548-43c7-bdea-66f371a02045","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": "234,200", "balance_before": "234,200", "tax": "0,000", "status_code": 200, "error": false, "message": "Consulta assincrona disparada com sucesso! Voce será tarifado somente quando o processamento terminar e tiver sucesso.", "valor_consulta": 0, "api_limit_for": "async", "homolog": true, "data": { "job-id": "e312f471-b548-43c7-bdea-66f371a02045", "job_status": "completed", "payload": { "dados": [ { "dadosDoVeiculo": { "chassi": "9BWAG42N7YT789012", "placa": "ABC1234", "renavam": "98765432100", "totalDebito": 1075.64 }, "debitosDPVAT": { "ocorrencia": null, "totalDebito": 0 }, "debitosIPVA": { "ocorrencia": null, "totalDebito": 0 }, "debitosLicenciamento": { "ocorrencia": null, "totalDebito": 0 }, "debitosMultas": { "ocorrencia": [ { "dataHoraMulta": "2025-02-15 10:45", "dataVencimento": "2025-04-18", "descricao": "Dirigir utilizando telefone celular", "fonte": "DETRAN - MARINGA", "identificador": "HML0004521", "linhaDigitavel": "null", "local": "Av. Brasil, 1500", "uf": "PR", "valor": 293.47 }, { "dataHoraMulta": "2025-05-20 17:30", "dataVencimento": "2025-07-22", "descricao": "Transitar em velocidade superior a maxima permitida em ate 20%", "fonte": "RENAINF", "identificador": "HML0008934", "linhaDigitavel": "null", "local": "BR-376 Km 210", "uf": "PR", "valor": 586.94 }, { "dataHoraMulta": "2025-08-03 22:10", "dataVencimento": "2025-10-05", "descricao": "Estacionar em local e horario de estacionamento rotativo", "fonte": "DETRAN - LONDRINA", "identificador": "HML0002167", "linhaDigitavel": "null", "local": "Rua Sergipe, 450", "uf": "PR", "valor": 195.23 } ], "quantidade": 3, "totalDebito": 1075.64 }, "outrosDebitos": { "ocorrencia": null, "totalDebito": 0 }, "pdf": null, "restricoes": null } ], "msg": "Consulta concluída com sucesso.", "success": true } } } ``` 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/9f74da75-5123b-4f3b-9533-cc7e9a5gf24/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/9f74da75-5123b-4f3b-9533-cc7e9a5gf24