Query parameters

• DateCreatedAfter string(date-time)

  Datetime filter used to consider only Verification Attempts created after this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.

• DateCreatedBefore string(date-time)

  Datetime filter used to consider only Verification Attempts created before this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.

• ChannelData.To string

  Destination of a verification. It is phone number in E.164 format.

• Country string(iso-country-code)

  Filter used to query Verification Attempts sent to the specified destination country.

• Channel string

  Filter used to query Verification Attempts by communication channel.

  Values are sms, call, email, whatsapp, or rbm.

• VerifyServiceSid string

  Filter used to query Verification Attempts by verify service. Only attempts of the provided SID will be returned.

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

• VerificationSid string

  Filter used to return all the Verification Attempts of a single verification. Only attempts of the provided verification SID will be returned.

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

• Status string

  Filter used to query Verification Attempts by conversion status. Valid values are UNCONVERTED, for attempts that were not converted, and CONVERTED, for attempts that were confirmed.

  Values are converted or unconverted.

• 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

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

    • sid string | null

      The SID that uniquely identifies the verification attempt resource.

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

    • account_sid string | null

      The SID of the Account that created the Verification resource.

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

    • service_sid string | null

      The SID of the Service used to generate the attempt.

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

    • verification_sid string | null

      The SID of the Verification that generated the attempt.

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

    • date_created string(date-time) | null

      The date that this Attempt was created, given in ISO 8601 format.

    • date_updated string(date-time) | null

      The date that this Attempt was updated, given in ISO 8601 format.

    • conversion_status string

      A string specifying the conversion status of the verification. A conversion happens when the user is able to provide the correct code. Possible values are CONVERTED and UNCONVERTED.

      Values are converted or unconverted.

    • channel string

      A string specifying the communication channel used for the verification attempt.

      Values are sms, call, email, whatsapp, or rbm.

    • price

      An object containing the charge for this verification attempt related to the channel costs and the currency used. The costs related to the succeeded verifications are not included. May not be immediately available. More information on pricing is available here.

    • channel_data

      An object containing the channel specific information for an attempt.

    • url string(uri) | null
  • 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)