← HomeFleetPay / Schema

VeiculoPedagio

Structure preserved from the versioned API contract.

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

operadorastringRequired

The responding operator. Deliberately echoed so that the data stored in your database retains its source.

"sem_parar" · "conectcar" · "veloe" · "move_mais"

placastringRequired

The queried license plate, normalized to uppercase without separators.

tem_tagbooleanRequired

Whether the vehicle has a toll tag — that is, whether it uses the automatic lane.

This is a response, not an inference: do not infer that there is no tag because identificador_tag is null.

identificador_tagstring | nullOptional

Tag code. Included only for vehicles with a tag; always null when tem_tag is false.

proprietariostring | nullOptional

Who the operator has registered for the vehicle.

descricaostring | nullOptional

Make, model and category, as returned by the operator.

eixosinteger | nullOptional

minimum2

maximum10

habilitado_vale_pedagiobooleanRequired

Whether a toll voucher can be issued for this vehicle.

Independent of tem_tag. A traditional voucher does not require a tag, and a vehicle with a tag may be blocked by the operator.

verificacaostringOptional

simulada when FleetPay generated the response without a contracted operator. Absence means a real verification.

Original JSON Definition (Portuguese Descriptions)

{
  "type": "object",
  "required": [
    "operadora",
    "placa",
    "tem_tag",
    "habilitado_vale_pedagio"
  ],
  "properties": {
    "operadora": {
      "type": "string",
      "enum": [
        "sem_parar",
        "conectcar",
        "veloe",
        "move_mais"
      ],
      "description": "A operadora que respondeu. Ecoada de propósito: o dado gravado na sua base carrega\na origem.\n"
    },
    "placa": {
      "type": "string",
      "description": "A placa consultada, normalizada em maiúsculas e sem separador."
    },
    "tem_tag": {
      "type": "boolean",
      "description": "Se o veículo carrega tag de pedágio — ou seja, se passa pela via automática.\n\nÉ **resposta**, não inferência: não deduza a ausência de tag de `identificador_tag`\nvir nulo.\n"
    },
    "identificador_tag": {
      "type": [
        "string",
        "null"
      ],
      "description": "O código da tag. Só acompanha quem tem tag — vem `null` sempre que `tem_tag` é\n`false`.\n"
    },
    "proprietario": {
      "type": [
        "string",
        "null"
      ],
      "description": "Quem o operador tem no cadastro do veículo."
    },
    "descricao": {
      "type": [
        "string",
        "null"
      ],
      "description": "Marca, modelo e categoria, como o operador os devolve."
    },
    "eixos": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 2,
      "maximum": 10
    },
    "habilitado_vale_pedagio": {
      "type": "boolean",
      "description": "Se dá para emitir Vale-Pedágio para este veículo.\n\n**Pergunta independente de `tem_tag`.** O vale tradicional não exige tag, e um\nveículo com tag pode estar bloqueado pelo operador.\n"
    },
    "verificacao": {
      "type": "string",
      "description": "`simulada` quando a resposta foi gerada pela FleetPay, sem operador contratado.\nAusente significa verificação real.\n"
    }
  }
}