Update Verification Request
Update an existing tollfree verification request. This is particularly useful when there are pending customer actions to be taken.
PATCH
/
messaging_tollfree
/
verification
/
requests
/
{id}
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const verificationRequestEgress = await client.messagingTollfree.verification.requests.update(
'182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
{
additionalInformation: 'additionalInformation',
businessAddr1: '600 Congress Avenue',
businessCity: 'Austin',
businessContactEmail: '[email protected]',
businessContactFirstName: 'John',
businessContactLastName: 'Doe',
businessContactPhone: '+18005550100',
businessName: 'Telnyx LLC',
businessState: 'Texas',
businessZip: '78701',
corporateWebsite: 'http://example.com',
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: [
{ url: 'https://telnyx.com/sign-up' },
{ url: 'https://telnyx.com/company/data-privacy' },
],
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',
},
);
console.log(verificationRequestEgress.id);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
verification_request_egress = client.messaging_tollfree.verification.requests.update(
id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
additional_information="additionalInformation",
business_addr1="600 Congress Avenue",
business_city="Austin",
business_contact_email="[email protected]",
business_contact_first_name="John",
business_contact_last_name="Doe",
business_contact_phone="+18005550100",
business_name="Telnyx LLC",
business_state="Texas",
business_zip="78701",
corporate_website="http://example.com",
message_volume="100,000",
opt_in_workflow="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",
opt_in_workflow_image_urls=[{
"url": "https://telnyx.com/sign-up"
}, {
"url": "https://telnyx.com/company/data-privacy"
}],
phone_numbers=[{
"phone_number": "+18773554398"
}, {
"phone_number": "+18773554399"
}],
production_message_content="Your Telnyx OTP is XXXX",
use_case="2FA",
use_case_summary="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",
)
print(verification_request_egress.id)
package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
verificationRequestEgress, err := client.MessagingTollfree.Verification.Requests.Update(
context.TODO(),
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
telnyx.MessagingTollfreeVerificationRequestUpdateParams{
TfVerificationRequest: telnyx.TfVerificationRequestParam{
AdditionalInformation: "additionalInformation",
BusinessAddr1: "600 Congress Avenue",
BusinessCity: "Austin",
BusinessContactEmail: "[email protected]",
BusinessContactFirstName: "John",
BusinessContactLastName: "Doe",
BusinessContactPhone: "+18005550100",
BusinessName: "Telnyx LLC",
BusinessState: "Texas",
BusinessZip: "78701",
CorporateWebsite: "http://example.com",
MessageVolume: telnyx.VolumeV100000,
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: []telnyx.URLParam{{
URL: "https://telnyx.com/sign-up",
}, {
URL: "https://telnyx.com/company/data-privacy",
}},
PhoneNumbers: []telnyx.TfPhoneNumberParam{{
PhoneNumber: "+18773554398",
}, {
PhoneNumber: "+18773554399",
}},
ProductionMessageContent: "Your Telnyx OTP is XXXX",
UseCase: telnyx.UseCaseCategoriesTwoFa,
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",
},
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", verificationRequestEgress.ID)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.messagingtollfree.verification.requests.RequestUpdateParams;
import com.telnyx.sdk.models.messagingtollfree.verification.requests.TfPhoneNumber;
import com.telnyx.sdk.models.messagingtollfree.verification.requests.TfVerificationRequest;
import com.telnyx.sdk.models.messagingtollfree.verification.requests.Url;
import com.telnyx.sdk.models.messagingtollfree.verification.requests.UseCaseCategories;
import com.telnyx.sdk.models.messagingtollfree.verification.requests.VerificationRequestEgress;
import com.telnyx.sdk.models.messagingtollfree.verification.requests.Volume;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
RequestUpdateParams params = RequestUpdateParams.builder()
.id("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
.tfVerificationRequest(TfVerificationRequest.builder()
.additionalInformation("additionalInformation")
.businessAddr1("600 Congress Avenue")
.businessCity("Austin")
.businessContactEmail("[email protected]")
.businessContactFirstName("John")
.businessContactLastName("Doe")
.businessContactPhone("+18005550100")
.businessName("Telnyx LLC")
.businessState("Texas")
.businessZip("78701")
.corporateWebsite("http://example.com")
.messageVolume(Volume.V_100000)
.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")
.addOptInWorkflowImageUrl(Url.builder()
.url("https://telnyx.com/sign-up")
.build())
.addOptInWorkflowImageUrl(Url.builder()
.url("https://telnyx.com/company/data-privacy")
.build())
.addPhoneNumber(TfPhoneNumber.builder()
.phoneNumber("+18773554398")
.build())
.addPhoneNumber(TfPhoneNumber.builder()
.phoneNumber("+18773554399")
.build())
.productionMessageContent("Your Telnyx OTP is XXXX")
.useCase(UseCaseCategories.TWO_FA)
.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")
.build())
.build();
VerificationRequestEgress verificationRequestEgress = client.messagingTollfree().verification().requests().update(params);
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
verification_request_egress = telnyx.messaging_tollfree.verification.requests.update(
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
additional_information: "additionalInformation",
business_addr1: "600 Congress Avenue",
business_city: "Austin",
business_contact_email: "[email protected]",
business_contact_first_name: "John",
business_contact_last_name: "Doe",
business_contact_phone: "+18005550100",
business_name: "Telnyx LLC",
business_state: "Texas",
business_zip: "78701",
corporate_website: "http://example.com",
message_volume: :"100,000",
opt_in_workflow: "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",
opt_in_workflow_image_urls: [{url: "https://telnyx.com/sign-up"}, {url: "https://telnyx.com/company/data-privacy"}],
phone_numbers: [{phoneNumber: "+18773554398"}, {phoneNumber: "+18773554399"}],
production_message_content: "Your Telnyx OTP is XXXX",
use_case: :"2FA",
use_case_summary: "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"
)
puts(verification_request_egress)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
use Telnyx\MessagingTollfree\Verification\Requests\Volume;
use Telnyx\MessagingTollfree\Verification\Requests\UseCaseCategories;
use Telnyx\MessagingTollfree\Verification\Requests\TollFreeVerificationEntityType;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$verificationRequestEgress = $client
->messagingTollfree
->verification
->requests
->update(
'182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
additionalInformation: 'additionalInformation',
businessAddr1: '600 Congress Avenue',
businessCity: 'Austin',
businessContactEmail: '[email protected]',
businessContactFirstName: 'John',
businessContactLastName: 'Doe',
businessContactPhone: '+18005550100',
businessName: 'Telnyx LLC',
businessState: 'Texas',
businessZip: '78701',
corporateWebsite: 'http://example.com',
messageVolume: Volume::V_100000,
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: [
['url' => 'https://telnyx.com/sign-up'],
['url' => 'https://telnyx.com/company/data-privacy'],
],
phoneNumbers: [
['phoneNumber' => '+18773554398'], ['phoneNumber' => '+18773554399']
],
productionMessageContent: 'Your Telnyx OTP is XXXX',
useCase: UseCaseCategories::TWO_FA,
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',
ageGatedContent: true,
businessAddr2: '14th Floor',
businessRegistrationCountry: 'US',
businessRegistrationNumber: '12-3456789',
businessRegistrationType: 'EIN',
campaignVerifyAuthorizationToken: 'cv_token_abc123xyz',
doingBusinessAs: 'Acme Services',
entityType: TollFreeVerificationEntityType::SOLE_PROPRIETOR,
helpMessageResponse: 'Reply HELP for assistance or STOP to unsubscribe. Contact: [email protected]',
isvReseller: 'isvReseller',
optInConfirmationResponse: 'You have successfully opted in to receive messages from Acme Corp',
optInKeywords: 'START, YES, SUBSCRIBE',
privacyPolicyURL: 'https://example.com/privacy',
termsAndConditionURL: 'https://example.com/terms',
webhookURL: 'http://example-webhook.com',
);
var_dump($verificationRequestEgress);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx messaging-tollfree:verification:requests update \
--api-key 'My API Key' \
--id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \
--additional-information additionalInformation \
--business-addr1 '600 Congress Avenue' \
--business-city Austin \
--business-contact-email [email protected] \
--business-contact-first-name John \
--business-contact-last-name Doe \
--business-contact-phone +18005550100 \
--business-name 'Telnyx LLC' \
--business-state Texas \
--business-zip 78701 \
--corporate-website http://example.com \
--message-volume 100,000 \
--opt-in-workflow "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" \
--opt-in-workflow-image-url '{url: https://telnyx.com/sign-up}' \
--opt-in-workflow-image-url '{url: https://telnyx.com/company/data-privacy}' \
--phone-number "{phoneNumber: '+18773554398'}" \
--phone-number "{phoneNumber: '+18773554399'}" \
--production-message-content 'Your Telnyx OTP is XXXX' \
--use-case 2FA \
--use-case-summary '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'curl --request PATCH \
--url https://api.telnyx.com/v2/messaging_tollfree/verification/requests/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"businessName": "Telnyx LLC",
"corporateWebsite": "http://example.com",
"businessAddr1": "600 Congress Avenue",
"businessCity": "Austin",
"businessState": "Texas",
"businessZip": "78701",
"businessContactFirstName": "John",
"businessContactLastName": "Doe",
"businessContactEmail": "[email protected]",
"businessContactPhone": "+18005550100",
"messageVolume": "100,000",
"phoneNumbers": [
{
"phoneNumber": "+18773554398"
},
{
"phoneNumber": "+18773554399"
}
],
"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",
"productionMessageContent": "Your Telnyx OTP is XXXX",
"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": [
{
"url": "https://telnyx.com/sign-up"
},
{
"url": "https://telnyx.com/company/data-privacy"
}
],
"additionalInformation": "<string>",
"businessAddr2": "14th Floor",
"isvReseller": "<string>",
"webhookUrl": "http://example-webhook.com",
"businessRegistrationNumber": "12-3456789",
"businessRegistrationType": "EIN",
"businessRegistrationCountry": "US",
"doingBusinessAs": "Acme Services",
"optInConfirmationResponse": "You have successfully opted in to receive messages from Acme Corp",
"helpMessageResponse": "Reply HELP for assistance or STOP to unsubscribe. Contact: [email protected]",
"privacyPolicyURL": "https://example.com/privacy",
"termsAndConditionURL": "https://example.com/terms",
"ageGatedContent": false,
"optInKeywords": "START, YES, SUBSCRIBE",
"campaignVerifyAuthorizationToken": "cv_token_abc123xyz"
}
EOF{
"businessName": "Telnyx LLC",
"corporateWebsite": "http://example.com",
"businessAddr1": "600 Congress Avenue",
"businessCity": "Austin",
"businessState": "Texas",
"businessZip": "78701",
"businessContactFirstName": "John",
"businessContactLastName": "Doe",
"businessContactEmail": "[email protected]",
"businessContactPhone": "+18005550100",
"messageVolume": "100,000",
"phoneNumbers": [
{
"phoneNumber": "+18773554398"
},
{
"phoneNumber": "+18773554399"
}
],
"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",
"productionMessageContent": "Your Telnyx OTP is XXXX",
"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"
}
],
"additionalInformation": "This is for security purposes, blah blah blah",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"verificationRequestId": "<string>",
"businessAddr2": "14th Floor",
"isvReseller": "Yes",
"webhookUrl": "http://example-webhook.com",
"businessRegistrationNumber": "12-3456789",
"businessRegistrationType": "EIN",
"businessRegistrationCountry": "US",
"doingBusinessAs": "Acme Services",
"entityType": "PRIVATE_PROFIT",
"optInConfirmationResponse": "You have successfully opted in to receive messages from Acme Corp",
"helpMessageResponse": "Reply HELP for assistance or STOP to unsubscribe. Contact: [email protected]",
"privacyPolicyURL": "https://example.com/privacy",
"termsAndConditionURL": "https://example.com/terms",
"ageGatedContent": false,
"optInKeywords": "START, YES, SUBSCRIBE",
"campaignVerifyAuthorizationToken": "cv_token_abc123xyz",
"verificationStatus": "In Progress"
}{
"errors": [
{
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Unique identifier of the resource.
Body
application/json
The body of a tollfree verification request
Name of the business; there are no specific formatting requirements
Maximum string length:
500Example:
"Telnyx LLC"
A URL, including the scheme, pointing to the corporate website
Maximum string length:
500Example:
"http://example.com"
Line 1 of the business address
Maximum string length:
500Example:
"600 Congress Avenue"
The city of the business address; the first letter should be capitalized
Maximum string length:
500Example:
"Austin"
The full name of the state (not the 2 letter code) of the business address; the first letter should be capitalized
Maximum string length:
500Example:
"Texas"
The ZIP code of the business address
Maximum string length:
500Example:
"78701"
First name of the business contact; there are no specific requirements on formatting
Maximum string length:
500Example:
"John"
Last name of the business contact; there are no specific requirements on formatting
Maximum string length:
500Example:
"Doe"
The phone number of the business contact in E.164 format
Maximum string length:
500Example:
"+18005550100"
Estimated monthly volume of messages from the given phone numbers
Available options:
10, 100, 1,000, 10,000, 100,000, 250,000, 500,000, 750,000, 1,000,000, 5,000,000, 10,000,000+ Example:
"100,000"
The phone numbers to request the verification of
Minimum array length:
1Show child attributes
Show child attributes
Example:
[
{ "phoneNumber": "+18773554398" },
{ "phoneNumber": "+18773554399" }
]
Machine-readable use-case for the phone numbers
Available options:
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 Example:
"2FA"
Human-readable summary of the desired use-case
Maximum string length:
500Example:
"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"
An example of a message that will be sent from the given phone numbers
Maximum string length:
1000Example:
"Your Telnyx OTP is XXXX"
Human-readable description of how end users will opt into receiving messages from the given phone numbers
Maximum string length:
500Example:
"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"
Images showing the opt-in workflow
Minimum array length:
1Show child attributes
Show child attributes
Example:
[
{ "url": "https://telnyx.com/sign-up" },
{
"url": "https://telnyx.com/company/data-privacy"
}
]
Any additional information
Maximum string length:
500Line 2 of the business address
Maximum string length:
500Example:
"14th Floor"
ISV name
Maximum string length:
500URL that should receive webhooks relating to this verification request
Maximum string length:
500Example:
"http://example-webhook.com"
Official business registration number (e.g., Employer Identification Number (EIN) in the U.S.). Required from January 2026.
Maximum string length:
500Example:
"12-3456789"
Type of business registration being provided. Required from January 2026.
Maximum string length:
500Example:
"EIN"
ISO 3166-1 alpha-2 country code of the issuing business authority. Must be exactly 2 letters. Automatically converted to uppercase. Required from January 2026.
Maximum string length:
2Pattern:
^[A-Z]{2}$Example:
"US"
Doing Business As (DBA) name if different from legal name
Maximum string length:
500Example:
"Acme Services"
Business entity classification. Must be one of the 5 valid enum values.
Available options:
SOLE_PROPRIETOR, PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, GOVERNMENT Message sent to users confirming their opt-in to receive messages
Maximum string length:
500Example:
"You have successfully opted in to receive messages from Acme Corp"
The message returned when users text 'HELP'
Maximum string length:
500Example:
"Reply HELP for assistance or STOP to unsubscribe. Contact: [email protected]"
URL pointing to the business's privacy policy. Plain string, no URL format validation.
Maximum string length:
500Example:
"https://example.com/privacy"
URL pointing to the business's terms and conditions. Plain string, no URL format validation.
Maximum string length:
500Example:
"https://example.com/terms"
Indicates if messaging content requires age gating (e.g., 18+). Defaults to false if not provided.
Keywords used to collect and process consumer opt-ins
Maximum string length:
500Example:
"START, YES, SUBSCRIBE"
Campaign Verify Authorization Token required for Political use case submissions starting February 17, 2026. This token is validated by Zipwhip and must be provided for all Political use case verifications after the deadline.
Maximum string length:
500Example:
"cv_token_abc123xyz"
Response
Successful Response
A verification request as it comes out of the database
Example:
"Telnyx LLC"
Example:
"http://example.com"
Example:
"600 Congress Avenue"
Example:
"Austin"
Example:
"Texas"
Example:
"78701"
Example:
"John"
Example:
"Doe"
Example:
Example:
"+18005550100"
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+
Available options:
10, 100, 1,000, 10,000, 100,000, 250,000, 500,000, 750,000, 1,000,000, 5,000,000, 10,000,000+ Example:
"100,000"
Show child attributes
Show child attributes
Example:
[
{ "phoneNumber": "+18773554398" },
{ "phoneNumber": "+18773554399" }
]
Tollfree usecase categories
Available options:
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 Example:
"2FA"
Example:
"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"
Example:
"Your Telnyx OTP is XXXX"
Example:
"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"
Show child attributes
Show child attributes
Example:
[
{ "url": "https://telnyx.com/sign-up" },
{
"url": "https://telnyx.com/company/data-privacy"
}
]
Example:
"This is for security purposes, blah blah blah"
Example:
"14th Floor"
Example:
"Yes"
Example:
"http://example-webhook.com"
Example:
"12-3456789"
Example:
"EIN"
Example:
"US"
Example:
"Acme Services"
Business entity classification
Available options:
SOLE_PROPRIETOR, PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, GOVERNMENT Example:
"PRIVATE_PROFIT"
Example:
"You have successfully opted in to receive messages from Acme Corp"
Example:
"Reply HELP for assistance or STOP to unsubscribe. Contact: [email protected]"
Example:
"https://example.com/privacy"
Example:
"https://example.com/terms"
Example:
false
Example:
"START, YES, SUBSCRIBE"
Campaign Verify Authorization Token required for Political use case submissions starting February 17, 2026
Maximum string length:
500Example:
"cv_token_abc123xyz"
Tollfree verification status
Available options:
Verified, Rejected, Waiting For Vendor, Waiting For Customer, Waiting For Telnyx, In Progress Was this page helpful?
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const verificationRequestEgress = await client.messagingTollfree.verification.requests.update(
'182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
{
additionalInformation: 'additionalInformation',
businessAddr1: '600 Congress Avenue',
businessCity: 'Austin',
businessContactEmail: '[email protected]',
businessContactFirstName: 'John',
businessContactLastName: 'Doe',
businessContactPhone: '+18005550100',
businessName: 'Telnyx LLC',
businessState: 'Texas',
businessZip: '78701',
corporateWebsite: 'http://example.com',
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: [
{ url: 'https://telnyx.com/sign-up' },
{ url: 'https://telnyx.com/company/data-privacy' },
],
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',
},
);
console.log(verificationRequestEgress.id);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
verification_request_egress = client.messaging_tollfree.verification.requests.update(
id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
additional_information="additionalInformation",
business_addr1="600 Congress Avenue",
business_city="Austin",
business_contact_email="[email protected]",
business_contact_first_name="John",
business_contact_last_name="Doe",
business_contact_phone="+18005550100",
business_name="Telnyx LLC",
business_state="Texas",
business_zip="78701",
corporate_website="http://example.com",
message_volume="100,000",
opt_in_workflow="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",
opt_in_workflow_image_urls=[{
"url": "https://telnyx.com/sign-up"
}, {
"url": "https://telnyx.com/company/data-privacy"
}],
phone_numbers=[{
"phone_number": "+18773554398"
}, {
"phone_number": "+18773554399"
}],
production_message_content="Your Telnyx OTP is XXXX",
use_case="2FA",
use_case_summary="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",
)
print(verification_request_egress.id)
package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
verificationRequestEgress, err := client.MessagingTollfree.Verification.Requests.Update(
context.TODO(),
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
telnyx.MessagingTollfreeVerificationRequestUpdateParams{
TfVerificationRequest: telnyx.TfVerificationRequestParam{
AdditionalInformation: "additionalInformation",
BusinessAddr1: "600 Congress Avenue",
BusinessCity: "Austin",
BusinessContactEmail: "[email protected]",
BusinessContactFirstName: "John",
BusinessContactLastName: "Doe",
BusinessContactPhone: "+18005550100",
BusinessName: "Telnyx LLC",
BusinessState: "Texas",
BusinessZip: "78701",
CorporateWebsite: "http://example.com",
MessageVolume: telnyx.VolumeV100000,
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: []telnyx.URLParam{{
URL: "https://telnyx.com/sign-up",
}, {
URL: "https://telnyx.com/company/data-privacy",
}},
PhoneNumbers: []telnyx.TfPhoneNumberParam{{
PhoneNumber: "+18773554398",
}, {
PhoneNumber: "+18773554399",
}},
ProductionMessageContent: "Your Telnyx OTP is XXXX",
UseCase: telnyx.UseCaseCategoriesTwoFa,
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",
},
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", verificationRequestEgress.ID)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.messagingtollfree.verification.requests.RequestUpdateParams;
import com.telnyx.sdk.models.messagingtollfree.verification.requests.TfPhoneNumber;
import com.telnyx.sdk.models.messagingtollfree.verification.requests.TfVerificationRequest;
import com.telnyx.sdk.models.messagingtollfree.verification.requests.Url;
import com.telnyx.sdk.models.messagingtollfree.verification.requests.UseCaseCategories;
import com.telnyx.sdk.models.messagingtollfree.verification.requests.VerificationRequestEgress;
import com.telnyx.sdk.models.messagingtollfree.verification.requests.Volume;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
RequestUpdateParams params = RequestUpdateParams.builder()
.id("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
.tfVerificationRequest(TfVerificationRequest.builder()
.additionalInformation("additionalInformation")
.businessAddr1("600 Congress Avenue")
.businessCity("Austin")
.businessContactEmail("[email protected]")
.businessContactFirstName("John")
.businessContactLastName("Doe")
.businessContactPhone("+18005550100")
.businessName("Telnyx LLC")
.businessState("Texas")
.businessZip("78701")
.corporateWebsite("http://example.com")
.messageVolume(Volume.V_100000)
.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")
.addOptInWorkflowImageUrl(Url.builder()
.url("https://telnyx.com/sign-up")
.build())
.addOptInWorkflowImageUrl(Url.builder()
.url("https://telnyx.com/company/data-privacy")
.build())
.addPhoneNumber(TfPhoneNumber.builder()
.phoneNumber("+18773554398")
.build())
.addPhoneNumber(TfPhoneNumber.builder()
.phoneNumber("+18773554399")
.build())
.productionMessageContent("Your Telnyx OTP is XXXX")
.useCase(UseCaseCategories.TWO_FA)
.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")
.build())
.build();
VerificationRequestEgress verificationRequestEgress = client.messagingTollfree().verification().requests().update(params);
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
verification_request_egress = telnyx.messaging_tollfree.verification.requests.update(
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
additional_information: "additionalInformation",
business_addr1: "600 Congress Avenue",
business_city: "Austin",
business_contact_email: "[email protected]",
business_contact_first_name: "John",
business_contact_last_name: "Doe",
business_contact_phone: "+18005550100",
business_name: "Telnyx LLC",
business_state: "Texas",
business_zip: "78701",
corporate_website: "http://example.com",
message_volume: :"100,000",
opt_in_workflow: "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",
opt_in_workflow_image_urls: [{url: "https://telnyx.com/sign-up"}, {url: "https://telnyx.com/company/data-privacy"}],
phone_numbers: [{phoneNumber: "+18773554398"}, {phoneNumber: "+18773554399"}],
production_message_content: "Your Telnyx OTP is XXXX",
use_case: :"2FA",
use_case_summary: "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"
)
puts(verification_request_egress)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
use Telnyx\MessagingTollfree\Verification\Requests\Volume;
use Telnyx\MessagingTollfree\Verification\Requests\UseCaseCategories;
use Telnyx\MessagingTollfree\Verification\Requests\TollFreeVerificationEntityType;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$verificationRequestEgress = $client
->messagingTollfree
->verification
->requests
->update(
'182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
additionalInformation: 'additionalInformation',
businessAddr1: '600 Congress Avenue',
businessCity: 'Austin',
businessContactEmail: '[email protected]',
businessContactFirstName: 'John',
businessContactLastName: 'Doe',
businessContactPhone: '+18005550100',
businessName: 'Telnyx LLC',
businessState: 'Texas',
businessZip: '78701',
corporateWebsite: 'http://example.com',
messageVolume: Volume::V_100000,
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: [
['url' => 'https://telnyx.com/sign-up'],
['url' => 'https://telnyx.com/company/data-privacy'],
],
phoneNumbers: [
['phoneNumber' => '+18773554398'], ['phoneNumber' => '+18773554399']
],
productionMessageContent: 'Your Telnyx OTP is XXXX',
useCase: UseCaseCategories::TWO_FA,
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',
ageGatedContent: true,
businessAddr2: '14th Floor',
businessRegistrationCountry: 'US',
businessRegistrationNumber: '12-3456789',
businessRegistrationType: 'EIN',
campaignVerifyAuthorizationToken: 'cv_token_abc123xyz',
doingBusinessAs: 'Acme Services',
entityType: TollFreeVerificationEntityType::SOLE_PROPRIETOR,
helpMessageResponse: 'Reply HELP for assistance or STOP to unsubscribe. Contact: [email protected]',
isvReseller: 'isvReseller',
optInConfirmationResponse: 'You have successfully opted in to receive messages from Acme Corp',
optInKeywords: 'START, YES, SUBSCRIBE',
privacyPolicyURL: 'https://example.com/privacy',
termsAndConditionURL: 'https://example.com/terms',
webhookURL: 'http://example-webhook.com',
);
var_dump($verificationRequestEgress);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx messaging-tollfree:verification:requests update \
--api-key 'My API Key' \
--id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e \
--additional-information additionalInformation \
--business-addr1 '600 Congress Avenue' \
--business-city Austin \
--business-contact-email [email protected] \
--business-contact-first-name John \
--business-contact-last-name Doe \
--business-contact-phone +18005550100 \
--business-name 'Telnyx LLC' \
--business-state Texas \
--business-zip 78701 \
--corporate-website http://example.com \
--message-volume 100,000 \
--opt-in-workflow "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" \
--opt-in-workflow-image-url '{url: https://telnyx.com/sign-up}' \
--opt-in-workflow-image-url '{url: https://telnyx.com/company/data-privacy}' \
--phone-number "{phoneNumber: '+18773554398'}" \
--phone-number "{phoneNumber: '+18773554399'}" \
--production-message-content 'Your Telnyx OTP is XXXX' \
--use-case 2FA \
--use-case-summary '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'curl --request PATCH \
--url https://api.telnyx.com/v2/messaging_tollfree/verification/requests/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"businessName": "Telnyx LLC",
"corporateWebsite": "http://example.com",
"businessAddr1": "600 Congress Avenue",
"businessCity": "Austin",
"businessState": "Texas",
"businessZip": "78701",
"businessContactFirstName": "John",
"businessContactLastName": "Doe",
"businessContactEmail": "[email protected]",
"businessContactPhone": "+18005550100",
"messageVolume": "100,000",
"phoneNumbers": [
{
"phoneNumber": "+18773554398"
},
{
"phoneNumber": "+18773554399"
}
],
"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",
"productionMessageContent": "Your Telnyx OTP is XXXX",
"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": [
{
"url": "https://telnyx.com/sign-up"
},
{
"url": "https://telnyx.com/company/data-privacy"
}
],
"additionalInformation": "<string>",
"businessAddr2": "14th Floor",
"isvReseller": "<string>",
"webhookUrl": "http://example-webhook.com",
"businessRegistrationNumber": "12-3456789",
"businessRegistrationType": "EIN",
"businessRegistrationCountry": "US",
"doingBusinessAs": "Acme Services",
"optInConfirmationResponse": "You have successfully opted in to receive messages from Acme Corp",
"helpMessageResponse": "Reply HELP for assistance or STOP to unsubscribe. Contact: [email protected]",
"privacyPolicyURL": "https://example.com/privacy",
"termsAndConditionURL": "https://example.com/terms",
"ageGatedContent": false,
"optInKeywords": "START, YES, SUBSCRIBE",
"campaignVerifyAuthorizationToken": "cv_token_abc123xyz"
}
EOF{
"businessName": "Telnyx LLC",
"corporateWebsite": "http://example.com",
"businessAddr1": "600 Congress Avenue",
"businessCity": "Austin",
"businessState": "Texas",
"businessZip": "78701",
"businessContactFirstName": "John",
"businessContactLastName": "Doe",
"businessContactEmail": "[email protected]",
"businessContactPhone": "+18005550100",
"messageVolume": "100,000",
"phoneNumbers": [
{
"phoneNumber": "+18773554398"
},
{
"phoneNumber": "+18773554399"
}
],
"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",
"productionMessageContent": "Your Telnyx OTP is XXXX",
"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"
}
],
"additionalInformation": "This is for security purposes, blah blah blah",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"verificationRequestId": "<string>",
"businessAddr2": "14th Floor",
"isvReseller": "Yes",
"webhookUrl": "http://example-webhook.com",
"businessRegistrationNumber": "12-3456789",
"businessRegistrationType": "EIN",
"businessRegistrationCountry": "US",
"doingBusinessAs": "Acme Services",
"entityType": "PRIVATE_PROFIT",
"optInConfirmationResponse": "You have successfully opted in to receive messages from Acme Corp",
"helpMessageResponse": "Reply HELP for assistance or STOP to unsubscribe. Contact: [email protected]",
"privacyPolicyURL": "https://example.com/privacy",
"termsAndConditionURL": "https://example.com/terms",
"ageGatedContent": false,
"optInKeywords": "START, YES, SUBSCRIBE",
"campaignVerifyAuthorizationToken": "cv_token_abc123xyz",
"verificationStatus": "In Progress"
}{
"errors": [
{
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
}
}
]
}