Query parameters

• 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

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

    • sid string | null

      The unique string that we created to identify the Service resource.

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

    • account_sid string | null

      The SID of the Account that created the Service resource.

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

    • friendly_name string | null

      The name that appears in the body of your verification messages. It can be up to 30 characters long and can include letters, numbers, spaces, dashes, underscores. Phone numbers, special characters or links are NOT allowed. It cannot contain more than 4 (consecutive or non-consecutive) digits. This value should not contain PII.

    • code_length integer

      The length of the verification code to generate.

      Default value is 0.

    • lookup_enabled boolean | null

      Whether to perform a lookup with each verification started and return info about the phone number.

    • psd2_enabled boolean | null

      Whether to pass PSD2 transaction parameters when starting a verification.

    • skip_sms_to_landlines boolean | null

      Whether to skip sending SMS verifications to landlines. Requires lookup_enabled.

    • dtmf_input_required boolean | null

      Whether to ask the user to press a number before delivering the verify code in a phone call.

    • tts_name string | null

      The name of an alternative text-to-speech service to use in phone calls. Applies only to TTS languages.

    • do_not_share_warning_enabled boolean | null

      Whether to add a security warning at the end of an SMS verification body. Disabled by default and applies only to SMS. Example SMS body: Your AppName verification code is: 1234. Don’t share this code with anyone; our employees will never ask for the code

    • custom_code_enabled boolean | null

      Whether to allow sending verifications with a custom code instead of a randomly generated one.

    • push

      Configurations for the Push factors (channel) created under this Service.

    • totp

      Configurations for the TOTP factors (channel) created under this Service.

    • default_template_sid string | null

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

    • whatsapp
    • verify_event_subscription_enabled boolean | null

      Whether to allow verifications from the service to reach the stream-events sinks if configured

    • date_created string(date-time) | null

      The date and time in GMT when the resource was created specified in RFC 2822 format.

    • date_updated string(date-time) | null

      The date and time in GMT when the resource was last updated specified in RFC 2822 format.

    • url string(uri) | null

      The absolute URL of the resource.

    • links object(uri-map) | null

      The URLs of related resources.

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