--- title: "Leilão V2 Assíncrona" description: "⚠️ Aviso: Esta consulta será debitada assim que o processamento assíncrono for concluído." lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/7c6bd80b-6bd8-42d2-f9a9-bd8080d52c8 markdown: https://doc.apibrasil.io/apis/creditos/7c6bd80b-6bd8-42d2-f9a9-bd8080d52c8.md source: apibrasil-documentation --- # Leilão V2 Assíncrona > ⚠️ Aviso: Esta consulta será debitada assim que o processamento assíncrono for concluído. - **Categoria:** Consultas Assíncronas - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 21,12 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/7c6bd80b-6bd8-42d2-f9a9-bd8080d52c8/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/vehicles/credits ⚠️ Aviso: A chave para utilizar essa consulta tem validade de 24 horas. API Leilão V2 Assíncrona - Consultas Rápidas para Maximizar Suas Oportunidades Com a API Leilão V2 Assíncrona, você integra de forma ágil ao seu sistema a consulta de créditos de veículos em leilão, ganhando rapidez e precisão na tomada de decisão. Por meio do método POST do endpoint consulta/vehicles/credits, sua empresa recebe retornos atualizados e detalhados diretamente em sua plataforma, economizando tempo e potencializando negócios nos mercados de compra e venda, financiamento ou avaliação de veículos. Simplifique processos, elimine etapas manuais e ofereça uma experiência mais competitiva com uma API robusta, flexível e pronta para escalar junto com o seu negócio. - **Método:** `POST` - **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/vehicles/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-leilao-v2", "job-id": "05d04ca5-31e8-4c65-89e1-e7496e8b0e2d", "homolog": true } ``` **Em 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-leilao-v2","job-id":"05d04ca5-31e8-4c65-89e1-e7496e8b0e2d","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": "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": "05d04ca5-31e8-4c65-89e1-e7496e8b0e2d", "job_status": "completed", "payload": { "consulta": { "debitado": false, "id": "35", "valor": 0 }, "dados": { "acessorios": { "veiculosFipe": [] }, "acessoriosCategorizados": { "acessorios": [], "categorias": [] }, "analiseRisco": { "imageLink": null, "indiceRisco": "2", "parecer": "Veiculo ficticio com baixo risco de recusa em comercializacao/seguro." }, "anoFabricacao": "2018", "anoModelo": "2019", "anuncio": { "data": "05/03/2022 09:30:00", "fotos": [], "fotosRaw": [], "km": "51200", "observacao": "Preco de vitrine exclusivo. Consulte condicoes e prazo da oferta com a loja.", "opcionais": [ { "descricao": "Direcao eletrica" }, { "descricao": "Alarme" }, { "descricao": "Ar condicionado" }, { "descricao": "Computador de bordo" }, { "descricao": "Travas eletricas" }, { "descricao": "Vidros eletricos" } ], "placa": "ABC1234", "valor": "27800.00" }, "baseEstadual": { "categoria": "PARTICULAR", "chassi": "9ZZZL00AA00012345", "combustivel": "FLEX", "comunicacaoInclusao": null, "comunicacaoVenda": "NAO CONSTA COMUNICACAO DE VENDAS", "cor": "AZUL", "dataAlteracaoMotor": null, "dataEmissaoCrv": "14/02/2024", "dataInclusaoIntencaoTrocaFinanceira": null, "dataLimiteRestricaoTributaria": null, "dataVenda": null, "dataVigenciaContratoFinanceira": null, "debitoCetesb": null, "debitoDer": null, "debitoDersa": null, "debitoDetran": null, "debitoDpvat": "0,00", "debitoIpva": "0,00", "debitoLicenciamento": "0,00", "debitoMultas": "0,00", "debitoMunicipais": "0,00", "debitoPoliciaRodoviariaFederal": null, "debitoRenainf": null, "especie": "PASSAGEIRO", "exercicioLicenciamento": null, "existeDebitoDpvat": "NAO EXISTE DEBITO DE DPVAT", "existeDebitoIpva": "NAO EXISTE DEBITO DE IPVA", "existeDebitoLicenciamento": "NAO EXISTE DEBITO DE LICENCIAMENTO", "existeDebitoMulta": "NAO EXISTE DEBITO DE MULTA", "intencaoDataInslusao": null, "intencaoDocFinanceira": null, "intencaoNomeFinanceira": null, "intencaoRestricaoFinanceira": null, "licdata": null, "motor": "XZ9AA00012345", "municipio": "CIDADE DAS PALMEIRAS", "observacoes": null, "outrasRestricoes1": "NADA CONSTA", "outrasRestricoes2": "RESERVA DE ALIENACAO FIDUCIARIA", "outrasRestricoes3": "NADA CONSTA", "outrasRestricoes4": "NADA CONSTA", "placa": "ABC123Z", "pronome": "MOTORISTA FICTICIO DA SILVA", "pronomeAnterior": null, "renavam": "00123456789", "restricaoAdminisrativa": "NADA CONSTA", "restricaoAmbiental": null, "restricaoArrendatario": null, "restricaoDataInclusao": null, "restricaoDocArrendatario": null, "restricaoFinanceira": "ALIENACAO FIDUCIARIA", "restricaoGuincho": "NADA CONSTA", "restricaoJudicial": "NADA CONSTA", "restricaoNomeAgente": null, "restricaoRenajud": "NADA CONSTA", "restricaoRouboFurto": "NADA CONSTA", "restricaoTributaria": "NADA CONSTA", "situacaoVeiculo": "CIRCULACAO", "tipo": "AUTOMOVEL", "tipoMarcacaoChassi": "NORMAL", "uf": "SP" }, "baseNacional": { "anoFabricacao": "2018", "anoModelo": "2019", "categoria": "PARTICULAR", "chassi": "9ZZZL00AA00012345", "combustivel": "ALCOOL/GASOLINA", "cor": "AZUL", "di": null, "docFaturado": "10987654000155", "documentoFaturado": { "enderecos": [ { "_id": "addr1", "cep": "11000-000", "cidade": "CIDADE DAS PALMEIRAS" }, { "_id": "addr2", "cep": "11000-000", "cidade": "CIDADE DAS PALMEIRAS" } ], "nomeFantasia": "FAZENDA DO VENTO", "razaoSocial": "FAZENDA DO VENTO VEICULOS LTDA" }, "dtEmissaoCrv": null, "dtUltimaAtualizacao": null, "especie": "PASSAGEIRO", "especieVeiculo": "PASSAGEIRO", "indicadorComunicacaoVendas": "NAO", "indicadorRestricaoRenajud": "NAO", "motor": "XZ9AA00012345", "municipio": "CIDADE DAS PALMEIRAS", "ocorrencia": "VEICULO NAO INDICA OCORRENCIA DE ROUBO/FURTO", "outrasRestricoes1": "NADA CONSTA", "outrasRestricoes2": "NADA CONSTA", "outrasRestricoes3": "POSSUI RENAINF", "outrasRestricoes4": "NADA CONSTA", "outrasRestricoes5": "NADA CONSTA", "outrasRestricoes6": "NADA CONSTA", "outrasRestricoes7": "NADA CONSTA", "outrasRestricoes8": "NADA CONSTA", "placa": "ABC1234", "renavam": "00123456789", "restricao1": "NADA CONSTA", "restricao2": "NADA CONSTA", "restricao3": "POSSUI RENAINF", "restricao4": "NADA CONSTA", "restricaoDataInclusao": null, "restricaoFinanciadora": "NADA CONSTA", "restricaoFinanciamento": null, "restricaoNomeAgente": null, "restricaoTipoTransacao": "NADA CONSTA", "situacaoVeiculo": "CIRCULACAO", "tipoDocFaturado": "JURIDICA", "tipoDocImportadora": null, "tipoMarcacaoChassi": "NORMAL", "tipoVeiculo": "AUTOMOVEL", "uf": "SP", "ufFaturado": "SP" }, "caixaCambio": null, "capMaxTracao": "0,0000", "capacidadeCarga": "00000", "capacidadePassageiro": "5", "categoria": "AU - HATCH PEQUENO", "cestaBasica": { "registros": [], "veiculosFipe": [] }, "chassi": "9ZZZL00AA00012345", "cidade": "NAO IDENTIFICADO", "cilindradas": "999", "cmt": null, "codigoCombustivel": "ALCOOL/GASOLINA", "codigoFipe": [ { "codigo": "002381-0", "valorZeroKM": "29999" }, { "codigo": "002382-8", "valorZeroKM": "31500" } ], "codigoMarcaModelo": "999888", "combustivel": "ALCOOL/GASOLINA", "comparativoEspecificacoes": { "opinioesDoDono": [], "veiculoComparativo": [] }, "corVeiculo": "AZUL", "custoMedio": { "custoCada10k": [], "custoDesgastePecasTotal": 0, "custoPlanoRevisaoTotal": 0, "custoTotal": 0 }, "dadosBasicosDoVeiculo": { "anoFabricacao": "2018", "anoModelo": "2019", "chassi": "9ZZZL00AA00012345", "cilindradas": "999", "codigoFipe": "23810", "combustivel": "Alcool, Gasolina", "descricao": "HATCH FLEX", "informacoesFipe": [ { "ano": "2019", "combustivel": "Flex", "fipeId": "23810", "historicoPreco": [ { "ano": "2021", "mes": "1", "predicao": false, "valor": "27000" }, { "ano": "2021", "mes": "6", "predicao": false, "valor": "27250" }, { "ano": "2022", "mes": "1", "predicao": false, "valor": "28100" }, { "ano": "2023", "mes": "1", "predicao": false, "valor": "28950" }, { "ano": "2024", "mes": "1", "predicao": false, "valor": "29500" } ], "marca": "Albatroz", "modelo": "VENTO", "valorAtual": "29650.00", "versao": "LX 1.0 12V FLEX 5P" } ], "informacoesGerais": [ { "fipeId": "23810", "idVersao": "0101", "marca": "Albatroz", "modelo": "Vento 5P (2017 => 2020)", "versao": "LX 1.0 12v Flex Mec." } ], "marca": "ALBATROZ", "nacional": "NACIONAL", "placa": "ABC123Z" }, "docFaturado": "10987654000155", "dtUltimaAtualizacao": null, "eixoTraseiroDif": null, "eixos": "2", "especieVeiculo": "PASSAGEIRO", "fichaTecnica": { "registros": [], "veiculosFipe": [] }, "fotos": [], "fotosLoteVeiculo": { "conteudo": [] }, "historicoAnuncios": [ { "data": "05/03/2022 09:30:00", "fotos": [], "km": "51200", "observacao": "Preco de vitrine exclusivo. Consulte condicoes e prazo da oferta com a loja.", "opcionais": [ { "descricao": "Direcao eletrica" }, { "descricao": "Alarme" }, { "descricao": "Ar condicionado" }, { "descricao": "Computador de bordo" }, { "descricao": "Travas eletricas" }, { "descricao": "Vidros eletricos" } ], "placa": "ABC1234", "valor": "27800.00" } ], "historicoKm": [ { "dataInclusao": "05/03/2022 09:30:00", "km": "51200" } ], "historicoProprietarios": [ { "anoExercicio": "2024", "chassi": "9ZZZL00AA00012345", "correlacaoChassiRenavam": false, "cpfCnpj": "00011122233", "dataEmplacamento": null, "dataProcessamento": null, "motivoTipoAutorizacao": null, "municipio": "CIDADE DAS PALMEIRAS", "ocorrencia": null, "placa": "ABC123Z", "proprietario": "MOTORISTA FICTICIO DA SILVA", "renavam": "00123456789", "tipoDocumento": null, "uf": "SP" } ], "identImportadora": null, "indicioSinistro": { "classificacao": null, "descricao": "Nao consta indicio de sinistro para o veiculo informado." }, "leilao": { "descricao": "Nao consta registro de leilao para o veiculo informado", "registros": [], "score": { "aceitacao": null, "exigenciaVistoriaEspecial": null, "percentualSobreRef": null, "pontuacao": null, "score": null } }, "limiteRestricaoTrib": null, "marcaModelo": "ALBATROZ/VENTO", "municipio": "NAO IDENTIFICADO", "municipioEmplacamento": "NAO IDENTIFICADO", "nacionalidade": "NACIONAL", "numCarroceria": "INEXISTENTE", "numFaturado": "10987654000155", "numMotor": "XZ9AA00012345", "numTerceiroEixo": null, "opcionais": [], "pbt": "0,0151", "placa": "ABC1234", "potencia": "75", "procedencia": "NACIONAL", "qtdPax": "5", "registroDi": null, "renavam": "123456789", "restricoes": null, "revisao": { "veiculosFipe": [] }, "situacaoChassi": " ", "situacaoVeiculo": " ", "tipoCarroceria": "Desconhecido", "tipoDocFaturado": "JURIDICA", "tipoDocImportadora": "DESCONHECIDA", "tipoMontagem": "1", "tipoVeiculo": "AUTOMOVEL", "uf": "--", "ufFaturado": "SP", "ultimaDataInclusao": null }, "msg": "CONSULTA CONCLUIDA COM SUCESSO", "success": true } } } ``` ### 2. POST /consulta/veiculos/credits ⚠️ Aviso: Esta consulta será debitada assim que o processamento assíncrono for concluído. API Leilão V2 - Histórico de Veículos com Agilidade e Precisão Com a API Leilão V2, sua empresa consulta rapidamente o histórico completo de leilões de um veículo, potencializando a tomada de decisão e agregando valor ao seu negócio. A integração é simples e eficiente, permitindo que você incorpore facilmente os dados diretamente ao seu sistema por meio do método POST. Com respostas detalhadas e atualizadas sobre participação e resultados em leilões, você oferece mais transparência aos seus clientes e ganha diferencial competitivo no mercado automotivo. - **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": "leilao-v2-async", "placa": "ABC1234", "webhook_url": "https://webhook.com.br", "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":"leilao-v2-async","placa":"ABC1234","webhook_url":"https://webhook.com.br","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": "366,780", "balance_before": "366,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": "733ba59a-cd89-4043-9c4f-f6ef8c3d937b", "msg": "consulta em processamento; resultado sera enviado ao webhook_url" } } ``` 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/7c6bd80b-6bd8-42d2-f9a9-bd8080d52c8/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/7c6bd80b-6bd8-42d2-f9a9-bd8080d52c8