← HomeFleetPay / Schema

Agregado

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.

CertificadoDoAgregado ↗ContaDoAgregado ↗

tipostringRequired

Contractor type: your company's driver or a carrier you hire or invited.

"motorista" · "transportadora"

documentostringRequired

CPF or CNPJ, digits only.

nomestring | nullOptional

The name registered with FleetPay. null for an invited person who has not completed registration — FleetPay does not yet know the name and reports that explicitly instead of returning a generic label.

cadastrostringRequired

convidado — an invitation exists, but registration does not; there is no account to display yet. cadastrado — registration exists in FleetPay, and conta reflects its actual state.

"convidado" · "cadastrado"

contaobjectRequired

ContaDoAgregado ↗

certificado_digitalobjectRequired

CertificadoDoAgregado ↗

Original JSON Definition (Portuguese Descriptions)

{
  "type": "object",
  "required": [
    "tipo",
    "documento",
    "cadastro",
    "conta",
    "certificado_digital"
  ],
  "properties": {
    "tipo": {
      "type": "string",
      "enum": [
        "motorista",
        "transportadora"
      ],
      "description": "A natureza do agregado — motorista da sua empresa ou transportadora que você contrata/convidou."
    },
    "documento": {
      "type": "string",
      "description": "CPF ou CNPJ, somente dígitos."
    },
    "nome": {
      "type": [
        "string",
        "null"
      ],
      "description": "Como está cadastrado na FleetPay. `null` para quem foi convidado e ainda não concluiu o cadastro — nesse momento a FleetPay ainda não sabe o nome, e preferimos dizer isso a devolver um rótulo genérico."
    },
    "cadastro": {
      "type": "string",
      "enum": [
        "convidado",
        "cadastrado"
      ],
      "description": "`convidado` — o convite existe e o cadastro não; não há conta a mostrar ainda. `cadastrado` — existe cadastro na FleetPay, e `conta` reflete o estado real dele."
    },
    "conta": {
      "$ref": "#/components/schemas/ContaDoAgregado"
    },
    "certificado_digital": {
      "$ref": "#/components/schemas/CertificadoDoAgregado"
    }
  }
}