{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/telnyx/json-schema/telnyx-verification-request-egress-schema.json",
  "title": "VerificationRequestEgress",
  "description": "A verification request as it comes out of the database",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-verification-requests-api-openapi.yml#/components/schemas/VerificationRequestEgress",
  "properties": {
    "additionalInformation": {
      "title": "Additionalinformation",
      "type": "string"
    },
    "ageGatedContent": {
      "title": "Agegatedcontent",
      "type": "boolean"
    },
    "businessAddr1": {
      "title": "Businessaddr1",
      "type": "string"
    },
    "businessAddr2": {
      "title": "Businessaddr2",
      "type": "string"
    },
    "businessCity": {
      "title": "Businesscity",
      "type": "string"
    },
    "businessContactEmail": {
      "title": "Businesscontactemail",
      "type": "string"
    },
    "businessContactFirstName": {
      "title": "Businesscontactfirstname",
      "type": "string"
    },
    "businessContactLastName": {
      "title": "Businesscontactlastname",
      "type": "string"
    },
    "businessContactPhone": {
      "title": "Businesscontactphone",
      "type": "string"
    },
    "businessName": {
      "title": "Businessname",
      "type": "string"
    },
    "businessRegistrationCountry": {
      "title": "Businessregistrationcountry",
      "type": "string"
    },
    "businessRegistrationNumber": {
      "title": "Businessregistrationnumber",
      "type": "string"
    },
    "businessRegistrationType": {
      "title": "Businessregistrationtype",
      "type": "string"
    },
    "businessState": {
      "title": "Businessstate",
      "type": "string"
    },
    "businessZip": {
      "title": "Businesszip",
      "type": "string"
    },
    "campaignVerifyAuthorizationToken": {
      "description": "Campaign Verify Authorization Token required for Political use case submissions starting February 17, 2026",
      "maxLength": 500,
      "title": "Campaignverifyauthorizationtoken",
      "type": [
        "string",
        "null"
      ]
    },
    "corporateWebsite": {
      "title": "Corporatewebsite",
      "type": "string"
    },
    "doingBusinessAs": {
      "title": "Doingbusinessas",
      "type": "string"
    },
    "entityType": {
      "allOf": [
        {
          "$ref": "#/$defs/toll-free-verification_EntityType"
        }
      ]
    },
    "helpMessageResponse": {
      "title": "Helpmessageresponse",
      "type": "string"
    },
    "id": {
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "isvReseller": {
      "title": "Isvreseller",
      "type": "string"
    },
    "messageVolume": {
      "allOf": [
        {
          "$ref": "#/$defs/Volume"
        }
      ],
      "description": "One of the following exact values: 10; 100; 1,000; 10,000; 100,000; 250,000; 500,000; 750,000; 1,000,000; 5,000,000; 10,000,000+"
    },
    "optInConfirmationResponse": {
      "title": "Optinconfirmationresponse",
      "type": "string"
    },
    "optInKeywords": {
      "title": "Optinkeywords",
      "type": "string"
    },
    "optInWorkflow": {
      "title": "Optinworkflow",
      "type": "string"
    },
    "optInWorkflowImageURLs": {
      "items": {
        "$ref": "#/$defs/Url"
      },
      "title": "Optinworkflowimageurls",
      "type": "array"
    },
    "phoneNumbers": {
      "items": {
        "$ref": "#/$defs/TFPhoneNumber"
      },
      "title": "Phonenumbers",
      "type": "array"
    },
    "privacyPolicyURL": {
      "title": "Privacypolicyurl",
      "type": "string"
    },
    "productionMessageContent": {
      "title": "Productionmessagecontent",
      "type": "string"
    },
    "termsAndConditionURL": {
      "title": "Termsandconditionurl",
      "type": "string"
    },
    "useCase": {
      "allOf": [
        {
          "$ref": "#/$defs/UseCaseCategories"
        }
      ]
    },
    "useCaseSummary": {
      "title": "Usecasesummary",
      "type": "string"
    },
    "verificationRequestId": {
      "title": "Verificationrequestid",
      "type": "string"
    },
    "verificationStatus": {
      "allOf": [
        {
          "$ref": "#/$defs/TFVerificationStatus"
        }
      ],
      "default": "In Progress"
    },
    "webhookUrl": {
      "title": "Webhookurl",
      "type": "string"
    }
  },
  "required": [
    "businessName",
    "corporateWebsite",
    "businessAddr1",
    "businessCity",
    "businessState",
    "businessZip",
    "businessContactFirstName",
    "businessContactLastName",
    "businessContactEmail",
    "businessContactPhone",
    "messageVolume",
    "phoneNumbers",
    "useCase",
    "useCaseSummary",
    "productionMessageContent",
    "optInWorkflow",
    "optInWorkflowImageURLs",
    "additionalInformation",
    "id",
    "verificationRequestId"
  ],
  "type": "object",
  "$defs": {
    "TFPhoneNumber": {
      "description": "A phone number",
      "properties": {
        "phoneNumber": {
          "title": "Phonenumber",
          "type": "string"
        }
      },
      "required": [
        "phoneNumber"
      ],
      "title": "PhoneNumber",
      "type": "object"
    },
    "TFVerificationStatus": {
      "description": "Tollfree verification status",
      "enum": [
        "Verified",
        "Rejected",
        "Waiting For Vendor",
        "Waiting For Customer",
        "Waiting For Telnyx",
        "In Progress"
      ],
      "title": "VerificationStatus",
      "type": "string"
    },
    "Url": {
      "properties": {
        "url": {
          "format": "uri",
          "maxLength": 2083,
          "minLength": 1,
          "title": "Url",
          "type": "string"
        }
      },
      "required": [
        "url"
      ],
      "title": "Url",
      "type": "object"
    },
    "UseCaseCategories": {
      "description": "Tollfree usecase categories",
      "enum": [
        "2FA",
        "App Notifications",
        "Appointments",
        "Auctions",
        "Auto Repair Services",
        "Bank Transfers",
        "Billing",
        "Booking Confirmations",
        "Business Updates",
        "COVID-19 Alerts",
        "Career Training",
        "Chatbot",
        "Conversational / Alerts",
        "Courier Services & Deliveries",
        "Emergency Alerts",
        "Events & Planning",
        "Financial Services",
        "Fraud Alerts",
        "Fundraising",
        "General Marketing",
        "General School Updates",
        "HR / Staffing",
        "Healthcare Alerts",
        "Housing Community Updates",
        "Insurance Services",
        "Job Dispatch",
        "Legal Services",
        "Mixed",
        "Motivational Reminders",
        "Notary Notifications",
        "Order Notifications",
        "Political",
        "Public Works",
        "Real Estate Services",
        "Religious Services",
        "Repair and Diagnostics Alerts",
        "Rewards Program",
        "Surveys",
        "System Alerts",
        "Voting Reminders",
        "Waitlist Alerts",
        "Webinar Reminders",
        "Workshop Alerts"
      ],
      "title": "UseCaseCategories",
      "type": "string"
    },
    "Volume": {
      "description": "Message Volume Enums",
      "enum": [
        "10",
        "100",
        "1,000",
        "10,000",
        "100,000",
        "250,000",
        "500,000",
        "750,000",
        "1,000,000",
        "5,000,000",
        "10,000,000+"
      ],
      "title": "Volume",
      "type": "string"
    },
    "toll-free-verification_EntityType": {
      "description": "Business entity classification",
      "enum": [
        "SOLE_PROPRIETOR",
        "PRIVATE_PROFIT",
        "PUBLIC_PROFIT",
        "NON_PROFIT",
        "GOVERNMENT"
      ],
      "title": "EntityType",
      "type": "string"
    }
  }
}