← HomeFleetPay / Schema

CiotOperationData

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.

CiotStatus ↗Cte ↗

document—Required

Cte ↗

ciotobjectRequired

CiotStatus ↗

Original JSON Definition (Portuguese Descriptions)

{
  "type": "object",
  "required": [
    "document",
    "ciot"
  ],
  "properties": {
    "document": {
      "anyOf": [
        {
          "type": "object",
          "allOf": [
            {
              "$ref": "#/components/schemas/Cte"
            }
          ]
        },
        {
          "type": "null"
        }
      ]
    },
    "ciot": {
      "type": "object",
      "required": [
        "status",
        "number",
        "verification_code",
        "protocol",
        "message"
      ],
      "properties": {
        "status": {
          "$ref": "#/components/schemas/CiotStatus"
        },
        "number": {
          "type": [
            "string",
            "null"
          ]
        },
        "verification_code": {
          "type": [
            "string",
            "null"
          ]
        },
        "protocol": {
          "type": [
            "string",
            "null"
          ]
        },
        "message": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    }
  }
}