Skip to main content

List Verification Requests

GET 
/messaging_tollfree/verification/requests

Get a list of previously-submitted tollfree verification requests

Request

Query Parameters

    page Pagerequired

    Possible values: >= 1

    page_size Page Sizerequired

    Possible values: >= 1

        Request this many records per page

    This value is automatically clamped if the provided value is too large.

    date_start date-time
    date_end date-time
    status VerificationStatus

    Possible values: [Verified, Rejected, Waiting For Vendor, Waiting For Customer, In Progress]

    phone_number Phone Number

Responses

200: Successful Response

default: Unexpected error

Request samples


curl -L 'https://api.telnyx.com/v2/messaging_tollfree/verification/requests' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples


{
"records": [
{
"businessName": "Telnyx LLC",
"corporateWebsite": "http://example.com",
"businessAddr1": "311 W Superior St",
"businessAddr2": "121 W Superior St",
"businessCity": "Chicago",
"businessState": "Illinois",
"businessZip": "60654",
"businessContactFirstName": "John",
"businessContactLastName": "Doe",
"businessContactEmail": "email@example.com",
"businessContactPhone": "+18889809750",
"messageVolume": "10",
"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",
"id": "eaba9f52-164e-58e0-b002-4f668e18b7ed",
"verificationStatus": "Verified",
"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"
}
],
"total_records": 0
}