BrandSmsOtpStatus

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/telnyx/main/json-schema/telnyx-brand-sms-otp-status-schema.json",
  "title": "BrandSmsOtpStatus",
  "description": "Status information for an SMS OTP sent during Sole Proprietor brand verification",
  "x-generated": "2026-10-08",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-brands-api-openapi.yml#/components/schemas/BrandSmsOtpStatus",
  "properties": {
    "brandId": {
      "description": "The Brand ID associated with this OTP request",
      "title": "Brandid",
      "type": "string"
    },
    "deliveryStatus": {
      "description": "The current delivery status of the OTP SMS message. Common values include: `DELIVERED_HANDSET`, `PENDING`, `FAILED`, `EXPIRED`",
      "title": "Deliverystatus",
      "type": "string"
    },
    "deliveryStatusDate": {
      "description": "The timestamp when the delivery status was last updated",
      "format": "date-time",
      "title": "Deliverystatusdate",
      "type": "string"
    },
    "deliveryStatusDetails": {
      "description": "Additional details about the delivery status",
      "title": "Deliverystatusdetails",
      "type": "string"
    },
    "mobilePhone": {
      "description": "The mobile phone number where the OTP was sent, in E.164 format",
      "title": "Mobilephone",
      "type": "string"
    },
    "referenceId": {
      "description": "The reference ID for this OTP request, used for status queries",
      "title": "Referenceid",
      "type": "string"
    },
    "requestDate": {
      "description": "The timestamp when the OTP request was initiated",
      "format": "date-time",
      "title": "Requestdate",
      "type": "string"
    },
    "verifyDate": {
      "description": "The timestamp when the OTP was successfully verified (if applicable)",
      "format": "date-time",
      "title": "Verifydate",
      "type": "string"
    }
  },
  "required": [
    "brandId",
    "referenceId",
    "mobilePhone",
    "requestDate",
    "deliveryStatus"
  ],
  "type": "object"
}