← InícioFleetPay / Schema

CertificateMetadata

Estrutura preservada do contrato versionado da API.

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

configuredbooleanObrigatório

Indica se há certificado cadastrado para a transportadora.

holder_namestring | nullObrigatório

Razão social extraída do certificado, quando disponível.

documentstring | nullObrigatório

Documento extraído do certificado, somente dígitos quando disponível.

valid_fromstring | null · dateObrigatório

valid_untilstring | null · dateObrigatório

statusstring | nullObrigatório

Situação calculada pela data de validade; null quando não há certificado.

"valido" · "expirado" · null

Definição JSON Completa

{
  "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."
    }
  }
}