--- title: "Documento CRLV DF Assíncrona" description: "API Documento CRLV DF (assíncrona) - Emissão do CRLV do Distrito Federal em PDF" lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/c362e752-c6bf-49d7-ada3-02771a27a8b9 markdown: https://doc.apibrasil.io/apis/creditos/c362e752-c6bf-49d7-ada3-02771a27a8b9.md source: apibrasil-documentation --- # Documento CRLV DF Assíncrona > API Documento CRLV DF (assíncrona) - Emissão do CRLV do Distrito Federal em PDF - **Categoria:** CRLV - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 79,80 por consulta - **Limite:** 999.000 por mês - **Cadastro:** exige CNPJ - **Versão:** v2 - **Publicada por:** APIBrasil - **Especificação OpenAPI:** https://doc.apibrasil.io/apis/creditos/c362e752-c6bf-49d7-ada3-02771a27a8b9/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 (2 endpoints) ### 1. POST /consulta/veiculos/credits ⚠️ Aviso: consulta assíncrona, atendida em horário comercial (segunda a sexta, das 9h às 18h, horário de Brasília). Fora desse horário o pedido é recusado, sem cobrança. O valor fica reservado no seu saldo e só é debitado quando o documento é emitido. API Documento CRLV DF - Emissão do CRLV do Distrito Federal (PDF) Envie um POST com tipo=documento-crlv-df-async, a placa (ABC1234 ou ABC1D23) e o webhook_url que vai receber o resultado. O veículo precisa estar registrado no Distrito Federal e com o licenciamento em dia. A resposta imediata traz o job-id. A emissão costuma levar de alguns minutos a algumas horas; pedidos feitos perto das 18h podem ser concluídos no dia útil seguinte. O resultado chega por POST no webhook_url, no formato {"job-id": "...", "payload": {"success": true, "consulta": {...}, "dados": {"consulta_id": "...", "placa": "...", "pdf": "..."}, "msg": "..."}}. O link do PDF fica disponível por 24 horas. Quando o documento não pode ser emitido, o payload vem com success=false, error_code e message, sem cobrança. Há um limite de pedidos em andamento por conta e não é possível repetir a mesma placa enquanto o pedido anterior estiver em andamento. Use homolog=true para testar a integração sem tarifar. - **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": "documento-crlv-df-async", "placa": "ABC1D23", "webhook_url": "https://seu-sistema.com.br/webhook", "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":"documento-crlv-df-async","placa":"ABC1D23","webhook_url":"https://seu-sistema.com.br/webhook","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": "400,000", "balance_before": "400,000", "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": false, "data": { "accepted": true, "job-id": "f015a7b2-6e22-44ee-a00b-2b2b5dc37450", "msg": "pedido em processamento; o resultado sera enviado ao webhook_url. A emissao e feita em horario comercial e a cobranca acontece quando o documento e emitido, mesmo que a entrega no webhook falhe.", "resultado": { "tipo": "consultar-chave-documento-crlv-df", "disponivel_por_horas": 24 } } } ``` ### 2. POST /consulta/veiculos/credits ⚠️ Aviso: esta consulta é gratuita. Depois de concluído, o resultado fica disponível por 24 horas. Consulta o andamento e o resultado do CRLV DF pelo job-id recebido no disparo. job_status: pending ou processing (pedido em andamento), completed (payload com o link do PDF) ou failed (payload com error_code e message, sem cobrança). - **Método:** `POST` - **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/veiculos/credits` - **Versão da rota:** v2 - **Preço desta operação:** R$ 0,00 por consulta **Cabeçalhos** | Cabeçalho | Valor | | --- | --- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer $APIBRASIL_TOKEN` | **Corpo da requisição** ```json { "tipo": "consultar-chave-documento-crlv-df", "job-id": "f015a7b2-6e22-44ee-a00b-2b2b5dc37450" } ``` **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":"consultar-chave-documento-crlv-df","job-id":"f015a7b2-6e22-44ee-a00b-2b2b5dc37450"}' ``` **Resposta de exemplo, do catálogo** ```json { "user": { "first_name": "[omitido]", "email": "[omitido]", "cellphone": "[omitido]", "notification": "yes" }, "balance": "320,200", "balance_before": "320,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": false, "data": { "job-id": "f015a7b2-6e22-44ee-a00b-2b2b5dc37450", "job_status": "completed", "payload": { "success": true, "consulta": { "debitado": true, "id": "e04fdc9e-374b-4d69-9116-8f157572303d", "valor": 79.8 }, "dados": { "consulta_id": "e04fdc9e-374b-4d69-9116-8f157572303d", "placa": "ABC1D23", "pdf": "https://gateway.apibrasil.io/proxy/?u=https%3A%2F%2Fdocumento-crlv.apiveiculos.com.br%2Fpdf%2Fe04fdc9e-374b-4d69-9116-8f157572303d" }, "msg": "CONSULTA CONCLUIDA COM SUCESSO" } } } ``` 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/c362e752-c6bf-49d7-ada3-02771a27a8b9/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/c362e752-c6bf-49d7-ada3-02771a27a8b9