Skip to main content
GET
/
messaging_tollfree
/
verification
/
requests
/
{id}
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const verificationRequestStatus = await client.messagingTollfree.verification.requests.retrieve(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(verificationRequestStatus.id);
{
  "businessName": "Telnyx LLC",
  "corporateWebsite": "http://example.com",
  "businessAddr1": "600 Congress Avenue",
  "businessAddr2": "14th Floor",
  "businessCity": "Austin",
  "businessState": "Texas",
  "businessZip": "78701",
  "businessContactFirstName": "John",
  "businessContactLastName": "Doe",
  "businessContactEmail": "email@example.com",
  "businessContactPhone": "+18889809750",
  "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",
  "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: support@example.com",
  "privacyPolicyURL": "https://example.com/privacy",
  "termsAndConditionURL": "https://example.com/terms",
  "ageGatedContent": false,
  "optInKeywords": "START, YES, SUBSCRIBE",
  "id": "eaba9f52-164e-58e0-b002-4f668e18b7ed",
  "verificationStatus": "Pending Customer Feedback",
  "reason": "Unfortunately, we have to cancel this request as we do not support non tollfree US numbers.",
  "createdAt": "2024-01-23T18:10:02.574Z",
  "updatedAt": "2024-01-23T18:10:02.574Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

Response

Successful Response

A verification request and its status, suitable for returning to users

​
businessName
string
required
Example:

"Telnyx LLC"

​
corporateWebsite
string
required
Example:

"http://example.com"

​
businessAddr1
string
required
Example:

"600 Congress Avenue"

​
businessCity
string
required
Example:

"Austin"

​
businessState
string
required
Example:

"Texas"

​
businessZip
string
required
Example:

"78701"

​
businessContactFirstName
string
required
Example:

"John"

​
businessContactLastName
string
required
Example:

"Doe"

​
businessContactEmail
string
required
Example:

"email@example.com"

​
businessContactPhone
string
required
Example:

"+18889809750"

​
messageVolume
enum<string>
required

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+ Message Volume Enums

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"

​
phoneNumbers
PhoneNumber · object[]
required
Example:
[
  { "phoneNumber": "+18773554398" },
  { "phoneNumber": "+18773554399" }
]
​
useCase
enum<string>
required

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"

​
useCaseSummary
string
required
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"

​
productionMessageContent
string
required
Example:

"Your Telnyx OTP is XXXX"

​
optInWorkflow
string
required
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"

​
optInWorkflowImageURLs
Url · object[]
required
Example:
[
  { "url": "https://telnyx.com/sign-up" },
  {
    "url": "https://telnyx.com/company/data-privacy"
  }
]
​
additionalInformation
string
required
Example:

"This is for security purposes, blah blah blah"

​
isvReseller
string
required
Example:

"Yes"

​
id
string<uuid>
required
Example:

"eaba9f52-164e-58e0-b002-4f668e18b7ed"

​
verificationStatus
enum<string>
required

Tollfree verification status

Available options:
Verified,
Rejected,
Waiting For Vendor,
Waiting For Customer,
Waiting For Telnyx,
In Progress
Example:

"Pending Customer Feedback"

​
businessAddr2
string
Example:

"14th Floor"

​
webhookUrl
string
Example:

"http://example-webhook.com"

​
businessRegistrationNumber
string
Example:

"12-3456789"

​
businessRegistrationType
string
Example:

"EIN"

​
businessRegistrationCountry
string
Example:

"US"

​
doingBusinessAs
string
Example:

"Acme Services"

​
entityType
enum<string>

Business entity classification

Available options:
SOLE_PROPRIETOR,
PRIVATE_PROFIT,
PUBLIC_PROFIT,
NON_PROFIT,
GOVERNMENT
Example:

"PRIVATE_PROFIT"

​
optInConfirmationResponse
string
Example:

"You have successfully opted in to receive messages from Acme Corp"

​
helpMessageResponse
string
Example:

"Reply HELP for assistance or STOP to unsubscribe. Contact: support@example.com"

​
privacyPolicyURL
string
Example:

"https://example.com/privacy"

​
termsAndConditionURL
string
Example:

"https://example.com/terms"

​
ageGatedContent
boolean
Example:

false

​
optInKeywords
string
Example:

"START, YES, SUBSCRIBE"

​
reason
string
Example:

"Unfortunately, we have to cancel this request as we do not support non tollfree US numbers."

​
createdAt
string<date-time>
Example:

"2024-01-23T18:10:02.574Z"

​
updatedAt
string<date-time>
Example:

"2024-01-23T18:10:02.574Z"