Sign in

v52

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
Verification Requests

Get Verification Request

Get a single verification request by its ID.

get/messaging_tollfree/verification/requests/{id}

Path parameters

idstring uuid required

Unique identifier of the resource.

Response

Successful Response

additionalInformationstring required
ageGatedContentboolean
businessAddr1string required
businessAddr2string
businessCitystring required
businessContactEmailstring required
businessContactFirstNamestring required
businessContactLastNamestring required
businessContactPhonestring required
businessNamestring required
businessRegistrationCountrystring
businessRegistrationNumberstring
businessRegistrationTypestring
businessStatestring required
businessZipstring required
campaignVerifyAuthorizationTokenstring nullable

Campaign Verify Authorization Token required for Political use case submissions starting February 17, 2026

corporateWebsitestring required
createdAtstring date-time
doingBusinessAsstring
entityType'SOLE_PROPRIETOR' | 'PRIVATE_PROFIT' | 'PUBLIC_PROFIT' | 'NON_PROFIT' | 'GOVERNMENT'

Business entity classification

helpMessageResponsestring
idstring uuid required
isvResellerstring
messageVolume'10' | '100' | '1,000' | '10,000' | '100,000' | '250,000' | '500,000' | '750,000' | '1,000,000' | '5,000,000' | '10,000,000+' required

Message Volume Enums

optInConfirmationResponsestring
optInKeywordsstring
optInWorkflowstring required
privacyPolicyURLstring
productionMessageContentstring required
reasonstring
termsAndConditionURLstring
updatedAtstring date-time
useCase'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' required

Tollfree usecase categories

useCaseSummarystring required
verificationStatus'Verified' | 'Rejected' | 'Waiting For Vendor' | 'Waiting For Customer' | 'Waiting For Telnyx' | 'In Progress' required

Tollfree verification status

webhookUrlstring

Example response

{
  "additionalInformation": "This is for security purposes, blah blah blah",
  "businessAddr1": "600 Congress Avenue",
  "businessAddr2": "14th Floor",
  "businessCity": "Austin",
  "businessContactEmail": "email@example.com",
  "businessContactFirstName": "John",
  "businessContactLastName": "Doe",
  "businessContactPhone": "+18889809750",
  "businessName": "Telnyx LLC",
  "businessRegistrationCountry": "US",
  "businessRegistrationNumber": "12-3456789",
  "businessRegistrationType": "EIN",
  "businessState": "Texas",
  "businessZip": "78701",
  "campaignVerifyAuthorizationToken": "cv_token_abc123xyz",
  "corporateWebsite": "http://example.com",
  "createdAt": "2024-01-23T18:10:02.574Z",
  "doingBusinessAs": "Acme Services",
  "helpMessageResponse": "Reply HELP for assistance or STOP to unsubscribe. Contact: support@example.com",
  "id": "eaba9f52-164e-58e0-b002-4f668e18b7ed",
  "isvReseller": "Yes",
  "optInConfirmationResponse": "You have successfully opted in to receive messages from Acme Corp",
  "optInKeywords": "START, YES, SUBSCRIBE",
  "optInWorkflow": "User signs into the Telnyx portal, enters number and is prompted to select whether they want to use 2FA verification for security purposes. If they've opted in a confirmation message is sent out to the handset",
  "optInWorkflowImageURLs": [
    {
      "url": "https://telnyx.com/sign-up"
    },
    {
      "url": "https://telnyx.com/company/data-privacy"
    }
  ],
  "phoneNumbers": [
    {
      "phoneNumber": "+18773554398"
    },
    {
      "phoneNumber": "+18773554399"
    }
  ],
  "privacyPolicyURL": "https://example.com/privacy",
  "productionMessageContent": "Your Telnyx OTP is XXXX",
  "reason": "Unfortunately, we have to cancel this request as we do not support non tollfree US numbers.",
  "termsAndConditionURL": "https://example.com/terms",
  "updatedAt": "2024-01-23T18:10:02.574Z",
  "useCaseSummary": "This is a use case where Telnyx sends out 2FA codes to portal users to verify their identity in order to sign into the portal",
  "webhookUrl": "http://example-webhook.com"
}