O que é
Consulta pública sobre informações de veículos cadastrados no Detran da Bahia.
Veja mais informações em nossa central de ajuda: Detran BA - Consulta Licenciamento.
Sobre a requisição:
Método: POST
Endereço: URL Base + /api/maestro/detran-ba/veiculos/consulta-licenciamento
URL Base:
Parâmetros do header
Nome | Tipo | Obrigatório? | Descrição |
---|---|---|---|
Authorization | String | Sim | Chave de API gerada no cadastro no Plexi, prefixada com |
Callback | String | Não | URL para onde o resultado da requisição será enviado via HTTP POST. |
Parâmetros do body
Nome | Tipo | Obrigatório? | Descrição |
---|---|---|---|
renavam | string | Sim | Renavam do veículo a ser pesquisado. |
Estrutura da resposta
Status | Significado | Descrição | Informações retornadas |
---|---|---|---|
201 | Created | Solicitação criada | Campo requestId, com o ID da requisição criada. |
422 | Unprocessable Entity | A solicitação contém erro | Em quais campos houve erro. |
Exemplos de retornos quando você faz a requisição:
Status 201
A consulta recebida com sucesso e será processada. Com o ID retornado você pode consultar se já houve resposta.
{ "requestId": "1fdd4247-4f98-4113-887a-b182117b0e42" }
Status 422
Significa que ocorreu um erro de validação dos dados enviados.
{ "message": "The given data was invalid.", "errors": { "cpf": [ "O campo cpf é obrigatório." ], "nome": [ "O campo name é obrigatório." ] } }
Resultados da pesquisa ( retornados no callback ou fazendo requisição à API de respostas )
Resposta com registro encontrado
{ "renavam": "999999999", "proprietario": "PROPRIETÁRIO DO VEÍCULO", "placa": "AAA0000", "anoLicenciamento": "2020", "anoLicenciado": "2010", "ipvaCota1": "28/05/2020 R$ 146.97", "ipvaCota2": "29/06/2020 R$ 146.97", "ipvaCota3": "30/07/2020 R$ 146.97", "ipvaCotaUnica": "30/07/2020 R$ 56.01", "licenciamentoAtual": "130.14", "licenciamentoExerciciosAnteriores": "864.44", "seguroObrigatorio": "12.3", "seguroExerciciosAnteriores": "84.58", "multasAPagar": "191.54", "totalAPagar": "1709.737", "restricao": "ADM DE CONS NACIONAL HONDA LTDA", "restricaoFinanceira": "Sim", "restricaoAdministrativa": "Não", "restricaoJuridica": "Não", "comunicacaoDeVenda": "Não", "registroDeRoubo": "0", "pdf": "JVBERi0xLjQKMSAwIG9iago8..." }
Resposta com erro
{ "status": "erro", "mensagem": "RENAVAM não encontrado." }