Query parameters

• TollfreePhoneNumberSid string

  The SID of the Phone Number associated with the Tollfree Verification.

  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^PN[0-9a-fA-F]{32}$.

• Status string

  The compliance status of the Tollfree Verification record.

  Values are PENDING_REVIEW, IN_REVIEW, TWILIO_APPROVED, or TWILIO_REJECTED.

• ExternalReferenceId string

  Customer supplied reference id for the Tollfree Verification record.

• IncludeSubAccounts boolean

  Whether to include Tollfree Verifications from sub accounts in list response.

• PageSize integer(int64)

  How many resources to return in each list page. The default is 50, and the maximum is 1000.

  Minimum value is 1, maximum value is 1000.

• Page integer

  The page index. This value is simply for client state.

  Minimum value is 0.

• PageToken string

  The page token. This is provided by the API.

Responses

• 200 application/json

  OK

  Hide headers attributes Show headers attributes

  • Access-Control-Allow-Origin string

    Specify the origin(s) allowed to access the resource

  • Access-Control-Allow-Methods string

    Specify the HTTP methods allowed when accessing the resource

  • Access-Control-Allow-Headers string

    Specify the headers allowed when accessing the resource

  • Access-Control-Allow-Credentials boolean

    Indicates whether the browser should include credentials

  • Access-Control-Expose-Headers string

    Headers exposed to the client

  Hide response attributes Show response attributes object

  • verifications array[object]
    Hide verifications attributes Show verifications attributes object

    • sid string | null

      The unique string to identify Tollfree Verification.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^HH[0-9a-fA-F]{32}$.

    • account_sid string | null

      The SID of the Account that created the Tollfree Verification resource.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • customer_profile_sid string | null

      Customer's Profile Bundle BundleSid.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^BU[0-9a-fA-F]{32}$.

    • trust_product_sid string | null

      Tollfree TrustProduct Bundle BundleSid.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^BU[0-9a-fA-F]{32}$.

    • date_created string(date-time) | null

      The date and time in GMT when the resource was created specified in ISO 8601 format.

    • date_updated string(date-time) | null

      The date and time in GMT when the resource was last updated specified in ISO 8601 format.

    • regulated_item_sid string | null

      The SID of the Regulated Item.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^RA[0-9a-fA-F]{32}$.

    • business_name string | null

      The name of the business or organization using the Tollfree number.

    • business_street_address string | null

      The address of the business or organization using the Tollfree number.

    • business_street_address2 string | null

      The address of the business or organization using the Tollfree number.

    • business_city string | null

      The city of the business or organization using the Tollfree number.

    • business_state_province_region string | null

      The state/province/region of the business or organization using the Tollfree number.

    • business_postal_code string | null

      The postal code of the business or organization using the Tollfree number.

    • business_country string | null

      The country of the business or organization using the Tollfree number.

    • business_website string | null

      The website of the business or organization using the Tollfree number.

    • business_contact_first_name string | null

      The first name of the contact for the business or organization using the Tollfree number.

    • business_contact_last_name string | null

      The last name of the contact for the business or organization using the Tollfree number.

    • business_contact_email string | null

      The email address of the contact for the business or organization using the Tollfree number.

    • business_contact_phone string(phone-number) | null

      The E.164 formatted phone number of the contact for the business or organization using the Tollfree number.

    • notification_email string | null

      The email address to receive the notification about the verification result. .

    • use_case_categories array[string] | null

      The category of the use case for the Tollfree Number. List as many are applicable..

    • use_case_summary string | null

      Use this to further explain how messaging is used by the business or organization.

    • production_message_sample string | null

      An example of message content, i.e. a sample message.

    • opt_in_image_urls array[string] | null

      Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL.

    • opt_in_type string

      Describe how a user opts-in to text messages.

      Values are VERBAL, WEB_FORM, PAPER_FORM, VIA_TEXT, MOBILE_QR_CODE, IMPORT, or IMPORT_PLEASE_REPLACE.

    • message_volume string | null

      Estimate monthly volume of messages from the Tollfree Number.

    • additional_information string | null

      Additional information to be provided for verification.

    • tollfree_phone_number_sid string | null

      The SID of the Phone Number associated with the Tollfree Verification.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^PN[0-9a-fA-F]{32}$.

    • status string

      The compliance status of the Tollfree Verification record.

      Values are PENDING_REVIEW, IN_REVIEW, TWILIO_APPROVED, or TWILIO_REJECTED.

    • url string(uri) | null

      The absolute URL of the Tollfree Verification resource.

    • rejection_reason string | null

      The rejection reason given when a Tollfree Verification has been rejected.

    • error_code integer | null

      The error code given when a Tollfree Verification has been rejected.

    • edit_expiration string(date-time) | null

      The date and time when the ability to edit a rejected verification expires.

    • edit_allowed boolean | null

      If a rejected verification is allowed to be edited/resubmitted. Some rejection reasons allow editing and some do not.

    • rejection_reasons array | null

      A list of rejection reasons and codes describing why a Tollfree Verification has been rejected.

    • resource_links object | null

      The URLs of the documents associated with the Tollfree Verification resource.

    • external_reference_id string | null

      An optional external reference ID supplied by customer and echoed back on status retrieval.

  • meta object
    Hide meta attributes Show meta attributes object

    • first_page_url string(uri)
    • key string
    • next_page_url string(uri) | null
    • page integer
    • page_size integer
    • previous_page_url string(uri) | null
    • url string(uri)