DocServiceDocument

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/telnyx/main/json-schema/telnyx-doc-service-document-schema.json",
  "title": "DocServiceDocument",
  "x-generated": "2026-10-08",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-documents-api-openapi.yml#/components/schemas/DocServiceDocument",
  "allOf": [
    {
      "$ref": "#/$defs/DocServiceRecord"
    },
    {
      "properties": {
        "av_scan_status": {
          "description": "The antivirus scan status of the document.",
          "enum": [
            "scanned",
            "infected",
            "pending_scan",
            "not_scanned"
          ],
          "readOnly": true,
          "type": "string"
        },
        "content_type": {
          "description": "The document's content_type.",
          "readOnly": true,
          "type": "string"
        },
        "customer_reference": {
          "description": "Optional reference string for customer tracking.",
          "type": "string"
        },
        "filename": {
          "description": "The filename of the document.",
          "type": "string"
        },
        "record_type": {
          "description": "Identifies the type of the resource.",
          "readOnly": true,
          "type": "string"
        },
        "sha256": {
          "description": "The document's SHA256 hash provided for optional verification purposes.",
          "readOnly": true,
          "type": "string"
        },
        "size": {
          "description": "Indicates the document's filesize",
          "properties": {
            "amount": {
              "description": "The number of bytes",
              "readOnly": true,
              "type": "integer"
            },
            "unit": {
              "description": "Identifies the unit",
              "readOnly": true,
              "type": "string"
            }
          },
          "readOnly": true,
          "type": "object"
        },
        "status": {
          "description": "Indicates the current document reviewing status",
          "enum": [
            "pending",
            "verified",
            "denied"
          ],
          "readOnly": true,
          "type": "string"
        }
      },
      "type": "object"
    }
  ],
  "$defs": {
    "DocServiceRecord": {
      "properties": {
        "created_at": {
          "description": "ISO 8601 formatted date-time indicating when the resource was created.",
          "readOnly": true,
          "type": "string"
        },
        "id": {
          "description": "Identifies the resource.",
          "format": "uuid",
          "readOnly": true,
          "type": "string"
        },
        "record_type": {
          "description": "Identifies the type of the resource.",
          "readOnly": true,
          "type": "string"
        },
        "updated_at": {
          "description": "ISO 8601 formatted date-time indicating when the resource was updated.",
          "readOnly": true,
          "type": "string"
        }
      },
      "type": "object"
    }
  }
}