List all the verification attempts for a given Account

GET /v2/Attempts

TODO: Resource-level docs

List all the verification attempts for a given Account.

Query parameters

  • DateCreatedAfter string(date-time)

    Datetime filter used to query Verification Attempts created after this datetime. Given as GMT in RFC 2822 format.

  • DateCreatedBefore string(date-time)

    Datetime filter used to query Verification Attempts created before this datetime. Given as GMT in RFC 2822 format.

  • 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. Valid values are SMS and CALL

    Values are sms, call, email, or whatsapp.

  • VerifyServiceSid string

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

  • VerificationSid string

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

  • 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

    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.

Responses

  • • 200

    OK

    Hide response attributes Show response attributes object
    • attempts array[object]
      Hide attempts attributes Show attempts attributes
      • account_sid string | null

        The SID of the Account that created the verification.

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

      • channel string | null

        Communication channel used for the attempt.

        Values are sms, call, email, or whatsapp.

      • channel_data

        An object containing the channel specific information for an attempt.

      • conversion_status string | null

        Status of the conversion for the verification.

        Values are converted or unconverted.

      • date_created string(date-time) | null

        The date this Attempt was created

      • date_updated string(date-time) | null

        The date this Attempt was updated

      • price

        An object containing the charge for this verification attempt.

      • service_sid string | null

        The SID of the verify service that generated this attempt.

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

      • sid string | null

        The SID that uniquely identifies the verification attempt.

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

      • url string(uri) | null
      • verification_sid string | null

        The SID of the verification that generated this attempt.

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

    • meta object
      Hide meta attributes Show meta attributes
GET /v2/Attempts 
curl \
 -X GET https://verify.twilio.com/v2/Attempts \
 --user "username:password"
Response examples (200) 
{
  "attempts": [
    {
      "account_sid": "string",
      "channel": "sms",
      "conversion_status": "converted",
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "service_sid": "string",
      "sid": "string",
      "url": "https://example.com",
      "verification_sid": "string"
    }
  ],
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  }
}