Telnyx · Schema

DocServiceDocument

CommunicationsCPaaSVoiceSMSIoTTelecommunicationsMessagingArtificial IntelligenceMCPVoice AIPhone NumbersInferenceNumber VerificationPhone VerificationOTP2FALookupVerifyNumber LookupCNAMIdentityFraud Prevention

Properties

Name Type Description
created_at string ISO 8601 formatted date-time indicating when the resource was created.
id string Identifies the resource.
record_type string Identifies the type of the resource.
updated_at string ISO 8601 formatted date-time indicating when the resource was updated.
av_scan_status string The antivirus scan status of the document.
content_type string The document's content_type.
customer_reference string Optional reference string for customer tracking.
filename string The filename of the document.
sha256 string The document's SHA256 hash provided for optional verification purposes.
size object Indicates the document's filesize
status string Indicates the current document reviewing status
View JSON Schema on GitHub

JSON Schema

telnyx-doc-service-document-schema.json Raw ↑
{
  "$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"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/telnyx-doc-service-document"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.