v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

Verification Requests

List Verification Requests

Get a list of previously-submitted tollfree verification requests

get/messaging_tollfree/verification/requests

Query parameters

pageinteger required

Page number to retrieve (1-based).

page_sizeinteger required

    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.

date_startstring date-time

Start of the date range filter (inclusive, ISO 8601).

date_endstring date-time

End of the date range filter (inclusive, ISO 8601).

Tollfree verification status

Filter results by status.

phone_numberstring

Filter results by phone number.

business_namestring

Filter verification requests by business name

Response

Successful Response

total_recordsinteger required

The total amount of records for these query parameters

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"
    }
  ]
}