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

Schema

    records

    object[]

    The records yielded by this request

  • Array [

    • businessName Businessname (string)required
    corporateWebsite Corporatewebsite (string)required
    businessAddr1 Businessaddr1 (string)required
    businessAddr2 Businessaddr2 (string)
    businessCity Businesscity (string)required
    businessState Businessstate (string)required
    businessZip Businesszip (string)required
    businessContactFirstName Businesscontactfirstname (string)required
    businessContactLastName Businesscontactlastname (string)required
    businessContactEmail Businesscontactemail (string)required
    businessContactPhone Businesscontactphone (string)required
    messageVolume Volume (string)required

    Possible 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

    phoneNumbers

    object[]

    required

  • Array [

    • phoneNumber Phonenumber (string)required

  • ]

    • useCase UseCaseCategories (string)required

    Possible values: [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]

    Tollfree usecase categories

    useCaseSummary Usecasesummary (string)required
    productionMessageContent Productionmessagecontent (string)required
    optInWorkflow Optinworkflow (string)required

    optInWorkflowImageURLs

    object[]

    required

  • Array [

    • url urirequired

    Possible values: non-empty and <= 2083 characters

  • ]

    • additionalInformation Additionalinformation (string)required
    isvReseller Isvreseller (string)required
    webhookUrl Webhookurl (string)
    id uuidrequired
    verificationStatus VerificationStatus (string)required

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

    Tollfree verification status

    reason Reason (string)
    createdAt date-time
    updatedAt date-time

  • ]

    • The records yielded by this request

    total_records Total Records (integer)

    Default value: 0

    The total amount of records for these query parameters

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

    • code integerrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object

  • ]

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
}