List Verification Requests
Get a list of previously-submitted tollfree verification requests
Query parameters
Page number to retrieve (1-based).
Request this many records per page
This value is automatically clamped if the provided value is too large.
Request this many records per page
This value is automatically clamped if the provided value is too large.
Start of the date range filter (inclusive, ISO 8601).
End of the date range filter (inclusive, ISO 8601).
Tollfree verification status
Filter results by status.
Filter results by phone number.
Filter verification requests by business name
Response
Successful Response
Example response
{
"records": [
{
"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"
}
]
}Changes
Changed in 2 of the 61 revisions of this API.2
- ▲
the
//response's property type changed fromintegertostring, and format fromint32to no format for statusresponse-property-type-changed
This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ▲
the
//response's property type changed fromstringtointeger, and format from no format toint32for statusresponse-property-type-changed
This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲