Detran BA - Consulta Licenciamento

O que é#

Consulta pública sobre informações de veículos cadastrados no Detran da Bahia.

Sobre a requisição#

Método: POST

Endereço: https://api.plexi.com.br/api/maestro/detran-ba/veiculos/consulta-licenciamento

Parâmetros do header#

Nome	Tipo	Obrigatório?	Descrição
Authorization	String	Sim	Chave de API gerada no cadastro no Plexi, prefixada com `Bearer`
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	Somente se chassi não for informado	Renavam do veículo a ser pesquisado.
chassi	string	Somente se renavam não for informado	Chassi 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.

JSON

{
  "requestId": "1fdd4247-4f98-4113-887a-b182117b0e42"
}

Status 422

Significa que ocorreu um erro de validação dos dados enviados.

JSON

{
  "message": "The given data was invalid.",
  "errors": {
    "cpf": [
      "O campo cpf é obrigatório."
    ],
    "nome": [
      "O campo nome é obrigatório."
    ]
  }
}

Resultados da pesquisa (retornados no callback ou fazendo requisição à API de respostas)#

Resposta com registro encontrado

JSON

{
  "propietario": "FULANO DE TAL",
  "placa": "ABC1234",
  "renavam": "999999999",
  "chassi": "99999999999999999",
  "marcaModelo": "HONDA/BIZ 125 ES",
  "anoModelo": 2011,
  "cor": "VERDE",
  "anoFabricacao": 2011,
  "debitosAnteriores": {
    "licenciamentoExerciciosAnteriores": {
      "debitos": [
        {
          "ano": 2018,
          "valor": 189.23
        },
        {
          "ano": 2019,
          "valor": 177.11
        },
        {
          "ano": 2020,
          "valor": 166.34
        }
      ],
      "debitosAnteriores": 420.22,
      "total": 952.93
    },
    "seguroExerciciosAnteriores": {
      "debitos": [
        {
          "ano": 2018,
          "valor": null
        },
        {
          "ano": 2019,
          "valor": null
        },
        {
          "ano": 2020,
          "valor": 12.3
        }
      ],
      "debitosAnteriores": null,
      "total": 12.3
    },
    "ipvaExerciciosAnteriores": {
      "debitos": [
        {
          "ano": 2018,
          "valor": 64.32
        },
        {
          "ano": 2019,
          "valor": 68.32
        },
        {
          "ano": 2020,
          "valor": 74.45
        }
      ],
      "debitosAnteriores": 0,
      "total": 207.08
    },
    "valorTotalPagar": 1172.31
  },
  "licenciamento": {
    "licenciamentoAtual": 151.16,
    "seguro": 0,
    "ipvaAtual": 0,
    "valorTotalMultasPagar": 0,
    "valorTotalDebitos": 1323.47
  },
  "multas": [
    {
      "orgaoAutuador": "SEINFRA - SEC. INFRAESTRUTURA-DERBA",
      "descricao": "TRANS VELOC SUP ATE 20P/C",
      "local": "ROD. BA099, KM 23,4 - SENTIDO CRESCENTE",
      "data": "01/01/2020",
      "status": "PI",
      "valor": 130.16
    },
    {
      "orgaoAutuador": "SEINFRA - SEC. INFRAESTRUTURA-DERBA",
      "descricao": "TRANS VELOC SUP ATE 20P/C",
      "local": "ROD. BA099, KM 11,1 - SENTIDO DECRESCENTE",
      "data": "01/01/2020",
      "status": "PI",
      "valor": 130.16
    }
  ],
  "infracoes": [
    {
      "orgaoAutuador": "SEINFRA - SEC. INFRAESTRUTURA-DERBA",
      "descricao": "VELOC MAX SUP 20% ATE 50%",
      "local": "ROD. BA099, KM 64,66 - SENTIDO CRESCENTE",
      "data": "01/01/2020",
      "status": "AI",
      "valor": 195.23
    },
    {
      "orgaoAutuador": "SEINFRA - SEC. INFRAESTRUTURA-DERBA",
      "descricao": "TRANS VELOC SUP ATE 20P/C",
      "local": "ROD. BA099, KM 13,23 - SENTIDO DECRESCENTE",
      "data": "01/01/2020",
      "status": "AI",
      "valor": 130.16
    },
    {
      "orgaoAutuador": "SEINFRA - SEC. INFRAESTRUTURA-DERBA",
      "descricao": "TRANS VELOC SUP ATE 20P/C",
      "local": "ROD. BA099, KM 13,08 - SENTIDO CRESCENTE",
      "data": "01/01/2020",
      "status": "AI",
      "valor": 130.16
    }
  ],
  "pdf": "{PDF EM BASE64}"
}

Resposta com erro

JSON

{
  "status": "erro",
  "mensagem": "Nenhum veículo foi localizado, favor verificar os dados informados.",
  "pdf": "{PDF EM BASE64}"
}