Messaging Toll-Free Verification API

Manage your tollfree verification requests API

List Verification Requests

Get a list of previously-submitted tollfree verification requests

SecuritybearerAuth
Request
query Parameters
page
required
integer (Page) >= 1
page_size
required
integer (Page Size) >= 1 
    Request this many records per page
    This value is automatically clamped if the provided value is too large.
date_start
string <date-time> (Date Start)
date_end
string <date-time> (Date End)
status
string (VerificationStatus)

Tollfree verification status

Enum: "Verified" "Rejected" "Waiting For Vendor" "Waiting For Customer" "In Progress"
phone_number
string (Phone Number)
Responses
200

Successful Response

Response Schema: application/json
Array of objects (Records)
Default: []

The records yielded by this request

total_records
integer (Total Records)
Default: 0

The total amount of records for these query parameters

default

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
get/messaging_tollfree/verification/requests
Request samples 
Response samples 
application/json
{
  • "records": [ ],
  • "total_records": 0
}
Submit Verification Request
Submit a new tollfree verification request


SecuritybearerAuth 
Request 
Request Body schema: application/json
required
additionalInformation
required
string (Additionalinformation) 
 
businessAddr1
required
string (Businessaddr1) 
 
businessAddr2
string (Businessaddr2) 
 
businessCity
required
string (Businesscity) 
 
businessContactEmail
required
string (Businesscontactemail) 
 
businessContactFirstName
required
string (Businesscontactfirstname) 
 
businessContactLastName
required
string (Businesscontactlastname) 
 
businessContactPhone
required
string (Businesscontactphone) 
 
businessName
required
string (Businessname) 
 
businessState
required
string (Businessstate) 
 
businessZip
required
string (Businesszip) 
 
corporateWebsite
required
string (Corporatewebsite) 
 
isvReseller
required
string (Isvreseller) 
 
messageVolume
required
string (Volume) 
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+


 Enum: "10" "100" "1,000" "10,000" "100,000" "250,000" "500,000" "750,000" "1,000,000" "5,000,000" "10,000,000+"  
optInWorkflow
required
string (Optinworkflow) 
 
required
Array of objects (Optinworkflowimageurls)   non-empty 
 
required
Array of objects (Phonenumbers) 
 
productionMessageContent
required
string (Productionmessagecontent) 
 
useCase
required
string (UseCaseCategories) 
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"  
useCaseSummary
required
string (Usecasesummary) 
 
webhookUrl
string (Webhookurl) 
 
Responses 
200
Successful Response


Response Schema: application/json
additionalInformation
required
string (Additionalinformation) 
 
businessAddr1
required
string (Businessaddr1) 
 
businessAddr2
string (Businessaddr2) 
 
businessCity
required
string (Businesscity) 
 
businessContactEmail
required
string (Businesscontactemail) 
 
businessContactFirstName
required
string (Businesscontactfirstname) 
 
businessContactLastName
required
string (Businesscontactlastname) 
 
businessContactPhone
required
string (Businesscontactphone) 
 
businessName
required
string (Businessname) 
 
businessState
required
string (Businessstate) 
 
businessZip
required
string (Businesszip) 
 
corporateWebsite
required
string (Corporatewebsite) 
 
id
required
string <uuid>  (Id) 
 
isvReseller
required
string (Isvreseller) 
 
messageVolume
required
string (Volume) 
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+


 Enum: "10" "100" "1,000" "10,000" "100,000" "250,000" "500,000" "750,000" "1,000,000" "5,000,000" "10,000,000+"  
optInWorkflow
required
string (Optinworkflow) 
 
required
Array of objects (Optinworkflowimageurls) 
 
required
Array of objects (Phonenumbers) 
 
productionMessageContent
required
string (Productionmessagecontent) 
 
useCase
required
string (UseCaseCategories) 
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"  
useCaseSummary
required
string (Usecasesummary) 
 
verificationRequestId
required
string (Verificationrequestid) 
 
verificationStatus
string (VerificationStatus) 
 Default:  "In Progress"
Tollfree verification status


 Enum: "Verified" "Rejected" "Waiting For Vendor" "Waiting For Customer" "In Progress"  
webhookUrl
string (Webhookurl) 
 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
post/messaging_tollfree/verification/requests
Request samples 
application/json
{
  • "additionalInformation": "This is for security purposes, blah blah blah",
  • "businessAddr1": "311 W Superior St",
  • "businessAddr2": "121 W Superior St",
  • "businessCity": "Chicago",
  • "businessContactEmail": "email@example.com",
  • "businessContactFirstName": "John",
  • "businessContactLastName": "Doe",
  • "businessContactPhone": "+18005550100",
  • "businessName": "Telnyx LLC",
  • "businessState": "Illinois",
  • "businessZip": "60654",
  • "corporateWebsite": "http://example.com",
  • "isvReseller": "Yes",
  • "messageVolume": "100,000",
  • "optInWorkflow": "User signs into the Telnyx portal, enters a 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": [],
  • "phoneNumbers": [
    • {
      • "phoneNumber": "+18773554398"
      },
    • {
      • "phoneNumber": "+18773554399"
      }
    ],
  • "productionMessageContent": "Your Telnyx OTP is XXXX",
  • "useCase": "2FA",
  • "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"
}
Response samples 
application/json
{
  • "additionalInformation": "This is for security purposes, blah blah blah",
  • "businessAddr1": "311 W Superior St",
  • "businessAddr2": "121 W Superior St",
  • "businessCity": "Chicago",
  • "businessContactEmail": "email@example.com",
  • "businessContactFirstName": "John",
  • "businessContactLastName": "Doe",
  • "businessContactPhone": "+18005550100",
  • "businessName": "Telnyx LLC",
  • "businessState": "Illinois",
  • "businessZip": "60654",
  • "corporateWebsite": "http://example.com",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "isvReseller": "Yes",
  • "messageVolume": "100,000",
  • "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": [],
  • "phoneNumbers": [
    • {
      • "phoneNumber": "+18773554398"
      },
    • {
      • "phoneNumber": "+18773554399"
      }
    ],
  • "productionMessageContent": "Your Telnyx OTP is XXXX",
  • "useCase": "2FA",
  • "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",
  • "verificationRequestId": "string",
  • "verificationStatus": "In Progress",
  • "webhookUrl": "http://example-webhook.com"
}
Get Verification Request
Get a single verification request by its ID.


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid>  (Id) 
 
Responses 
200
Successful Response


Response Schema: application/json
additionalInformation
required
string (Additionalinformation) 
 
businessAddr1
required
string (Businessaddr1) 
 
businessAddr2
string (Businessaddr2) 
 
businessCity
required
string (Businesscity) 
 
businessContactEmail
required
string (Businesscontactemail) 
 
businessContactFirstName
required
string (Businesscontactfirstname) 
 
businessContactLastName
required
string (Businesscontactlastname) 
 
businessContactPhone
required
string (Businesscontactphone) 
 
businessName
required
string (Businessname) 
 
businessState
required
string (Businessstate) 
 
businessZip
required
string (Businesszip) 
 
corporateWebsite
required
string (Corporatewebsite) 
 
id
required
string <uuid>  (Id) 
 
isvReseller
required
string (Isvreseller) 
 
messageVolume
required
string (Volume) 
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+


 Enum: "10" "100" "1,000" "10,000" "100,000" "250,000" "500,000" "750,000" "1,000,000" "5,000,000" "10,000,000+"  
optInWorkflow
required
string (Optinworkflow) 
 
required
Array of objects (Optinworkflowimageurls) 
 
required
Array of objects (Phonenumbers) 
 
productionMessageContent
required
string (Productionmessagecontent) 
 
reason
string (Reason) 
 
useCase
required
string (UseCaseCategories) 
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"  
useCaseSummary
required
string (Usecasesummary) 
 
verificationStatus
required
string (VerificationStatus) 
Tollfree verification status


 Enum: "Verified" "Rejected" "Waiting For Vendor" "Waiting For Customer" "In Progress"  
webhookUrl
string (Webhookurl) 
 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
get/messaging_tollfree/verification/requests/{id}
Request samples 
Response samples 
application/json
{
  • "additionalInformation": "This is for security purposes, blah blah blah",
  • "businessAddr1": "311 W Superior St",
  • "businessAddr2": "121 W Superior St",
  • "businessCity": "Chicago",
  • "businessContactEmail": "email@example.com",
  • "businessContactFirstName": "John",
  • "businessContactLastName": "Doe",
  • "businessContactPhone": "+18889809750",
  • "businessName": "Telnyx LLC",
  • "businessState": "Illinois",
  • "businessZip": "60654",
  • "corporateWebsite": "http://example.com",
  • "id": "eaba9f52-164e-58e0-b002-4f668e18b7ed",
  • "isvReseller": "Yes",
  • "messageVolume": "100,000",
  • "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": [],
  • "phoneNumbers": [
    • {
      • "phoneNumber": "+18773554398"
      },
    • {
      • "phoneNumber": "+18773554399"
      }
    ],
  • "productionMessageContent": "Your Telnyx OTP is XXXX",
  • "reason": "Unfortunately, we have to cancel this request as we do not support non tollfree US numbers.",
  • "useCase": "2FA",
  • "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",
  • "verificationStatus": "Pending Customer Feedback",
  • "webhookUrl": "http://example-webhook.com"
}
Update Verification Request
Update an existing tollfree verification request. This is particularly useful when there are pending customer actions to be taken.


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid>  (Id) 
 
Request Body schema: application/json
required
additionalInformation
required
string (Additionalinformation) 
 
businessAddr1
required
string (Businessaddr1) 
 
businessAddr2
string (Businessaddr2) 
 
businessCity
required
string (Businesscity) 
 
businessContactEmail
required
string (Businesscontactemail) 
 
businessContactFirstName
required
string (Businesscontactfirstname) 
 
businessContactLastName
required
string (Businesscontactlastname) 
 
businessContactPhone
required
string (Businesscontactphone) 
 
businessName
required
string (Businessname) 
 
businessState
required
string (Businessstate) 
 
businessZip
required
string (Businesszip) 
 
corporateWebsite
required
string (Corporatewebsite) 
 
isvReseller
required
string (Isvreseller) 
 
messageVolume
required
string (Volume) 
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+


 Enum: "10" "100" "1,000" "10,000" "100,000" "250,000" "500,000" "750,000" "1,000,000" "5,000,000" "10,000,000+"  
optInWorkflow
required
string (Optinworkflow) 
 
required
Array of objects (Optinworkflowimageurls)   non-empty 
 
required
Array of objects (Phonenumbers) 
 
productionMessageContent
required
string (Productionmessagecontent) 
 
useCase
required
string (UseCaseCategories) 
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"  
useCaseSummary
required
string (Usecasesummary) 
 
webhookUrl
string (Webhookurl) 
 
Responses 
200
Successful Response


Response Schema: application/json
additionalInformation
required
string (Additionalinformation) 
 
businessAddr1
required
string (Businessaddr1) 
 
businessAddr2
string (Businessaddr2) 
 
businessCity
required
string (Businesscity) 
 
businessContactEmail
required
string (Businesscontactemail) 
 
businessContactFirstName
required
string (Businesscontactfirstname) 
 
businessContactLastName
required
string (Businesscontactlastname) 
 
businessContactPhone
required
string (Businesscontactphone) 
 
businessName
required
string (Businessname) 
 
businessState
required
string (Businessstate) 
 
businessZip
required
string (Businesszip) 
 
corporateWebsite
required
string (Corporatewebsite) 
 
id
required
string <uuid>  (Id) 
 
isvReseller
required
string (Isvreseller) 
 
messageVolume
required
string (Volume) 
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+


 Enum: "10" "100" "1,000" "10,000" "100,000" "250,000" "500,000" "750,000" "1,000,000" "5,000,000" "10,000,000+"  
optInWorkflow
required
string (Optinworkflow) 
 
required
Array of objects (Optinworkflowimageurls) 
 
required
Array of objects (Phonenumbers) 
 
productionMessageContent
required
string (Productionmessagecontent) 
 
useCase
required
string (UseCaseCategories) 
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"  
useCaseSummary
required
string (Usecasesummary) 
 
verificationRequestId
required
string (Verificationrequestid) 
 
verificationStatus
string (VerificationStatus) 
 Default:  "In Progress"
Tollfree verification status


 Enum: "Verified" "Rejected" "Waiting For Vendor" "Waiting For Customer" "In Progress"  
webhookUrl
string (Webhookurl) 
 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
patch/messaging_tollfree/verification/requests/{id}
Request samples 
application/json
{
  • "additionalInformation": "This is for security purposes, blah blah blah",
  • "businessAddr1": "311 W Superior St",
  • "businessAddr2": "121 W Superior St",
  • "businessCity": "Chicago",
  • "businessContactEmail": "email@example.com",
  • "businessContactFirstName": "John",
  • "businessContactLastName": "Doe",
  • "businessContactPhone": "+18005550100",
  • "businessName": "Telnyx LLC",
  • "businessState": "Illinois",
  • "businessZip": "60654",
  • "corporateWebsite": "http://example.com",
  • "isvReseller": "Yes",
  • "messageVolume": "100,000",
  • "optInWorkflow": "User signs into the Telnyx portal, enters a 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": [],
  • "phoneNumbers": [
    • {
      • "phoneNumber": "+18773554398"
      },
    • {
      • "phoneNumber": "+18773554399"
      }
    ],
  • "productionMessageContent": "Your Telnyx OTP is XXXX",
  • "useCase": "2FA",
  • "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"
}
Response samples 
application/json
{
  • "additionalInformation": "This is for security purposes, blah blah blah",
  • "businessAddr1": "311 W Superior St",
  • "businessAddr2": "121 W Superior St",
  • "businessCity": "Chicago",
  • "businessContactEmail": "email@example.com",
  • "businessContactFirstName": "John",
  • "businessContactLastName": "Doe",
  • "businessContactPhone": "+18005550100",
  • "businessName": "Telnyx LLC",
  • "businessState": "Illinois",
  • "businessZip": "60654",
  • "corporateWebsite": "http://example.com",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "isvReseller": "Yes",
  • "messageVolume": "100,000",
  • "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": [],
  • "phoneNumbers": [
    • {
      • "phoneNumber": "+18773554398"
      },
    • {
      • "phoneNumber": "+18773554399"
      }
    ],
  • "productionMessageContent": "Your Telnyx OTP is XXXX",
  • "useCase": "2FA",
  • "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",
  • "verificationRequestId": "string",
  • "verificationStatus": "In Progress",
  • "webhookUrl": "http://example-webhook.com"
}