← HomeFleetPay / Schema

CertificateMetadata

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.

configuredbooleanRequired

Indicates whether a certificate is registered for the carrier.

holder_namestring | nullRequired

Legal company name extracted from the certificate, when available.

documentstring | nullRequired

Tax identifier extracted from the certificate, digits only when available.

valid_fromstring | null · dateRequired

valid_untilstring | null · dateRequired

statusstring | nullRequired

Status calculated from the expiration date; null when there is no certificate.

"valido" · "expirado" · null

Original JSON Definition (Portuguese Descriptions)

{
  "type": "object",
  "required": [
    "configured",
    "holder_name",
    "document",
    "valid_from",
    "valid_until",
    "status"
  ],
  "properties": {
    "configured": {
      "type": "boolean",
      "description": "Indica se há certificado cadastrado para a transportadora."
    },
    "holder_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "Razão social extraída do certificado, quando disponível."
    },
    "document": {
      "type": [
        "string",
        "null"
      ],
      "description": "Documento extraído do certificado, somente dígitos quando disponível."
    },
    "valid_from": {
      "type": [
        "string",
        "null"
      ],
      "format": "date"
    },
    "valid_until": {
      "type": [
        "string",
        "null"
      ],
      "format": "date"
    },
    "status": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "valido",
        "expirado",
        null
      ],
      "description": "Situação calculada pela data de validade; null quando não há certificado."
    }
  }
}