Verification Requests

List Verification Requests

Changed on

Get a list of previously-submitted tollfree verification requests

get/messaging_tollfree/verification/requests

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/messaging_tollfree/verification/requests
  • Auth: HTTP bearer

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.
    
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).

status'Verified' | 'Rejected' | 'Waiting For Vendor' | 'Waiting For Customer' | 'Waiting For Telnyx' | 'In Progress'

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": [
    {
      "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",
      "phoneNumbers": [
        {
          "phoneNumber": "+18773554398"
        },
        {
          "phoneNumber": "+18773554399"
        }
      ],
      "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",
      "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",
      "optInKeywords": "START, YES, SUBSCRIBE",
      "campaignVerifyAuthorizationToken": "cv_token_abc123xyz",
      "id": "eaba9f52-164e-58e0-b002-4f668e18b7ed",
      "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"
    }
  ]
}

Changes

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status