Retrieve a list of all Challenges for a Factor

GET /v2/Services/{ServiceSid}/Entities/{Identity}/Challenges

TODO: Resource-level docs

Retrieve a list of all Challenges for a Factor.

Path parameters

  • ServiceSid string Required

    The unique SID identifier of the Service.

  • Identity string Required

    Customer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.

Query parameters

  • FactorSid string

    The unique SID identifier of the Factor.

  • Status string

    The Status of the Challenges to fetch. One of pending, expired, approved or denied.

    Values are pending, expired, approved, or denied.

  • Order string

    The desired sort order of the Challenges list. One of asc or desc for ascending and descending respectively. Defaults to asc.

    Values are asc or desc.

  • 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
    • challenges array[object]
      Hide challenges attributes Show challenges attributes
      • account_sid string | null

        Account Sid.

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

      • date_created string(date-time) | null

        The date this Challenge was created

      • date_responded string(date-time) | null

        The date this Challenge was responded

      • date_updated string(date-time) | null

        The date this Challenge was updated

      • details

        Details about the Challenge.

      • entity_sid string | null

        Entity Sid.

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

      • expiration_date string(date-time) | null

        The date-time when this Challenge expires

      • factor_sid string | null

        Factor Sid.

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

      • factor_type string | null

        The Factor Type of this Challenge

        Values are push or totp.

      • hidden_details

        Hidden details about the Challenge

      • identity string | null

        Unique external identifier of the Entity

      • links object(uri-map) | null

        Nested resource URLs.

      • metadata

        Metadata of the challenge.

      • responded_reason string | null

        The Reason of this Challenge status

        Values are none, not_needed, or not_requested.

      • service_sid string | null

        Service Sid.

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

      • sid string | null

        A string that uniquely identifies this Challenge.

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

      • status string | null

        The Status of this Challenge

        Values are pending, expired, approved, or denied.

      • url string(uri) | null

        The URL of this resource.

    • meta object
      Hide meta attributes Show meta attributes
GET /v2/Services/{ServiceSid}/Entities/{Identity}/Challenges 
curl \
 -X GET https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Challenges \
 --user "username:password"
Response examples (200) 
{
  "challenges": [
    {
      "account_sid": "string",
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_responded": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "entity_sid": "string",
      "expiration_date": "2023-05-04T09:42:00+00:00",
      "factor_sid": "string",
      "factor_type": "push",
      "identity": "string",
      "links": {},
      "responded_reason": "none",
      "service_sid": "string",
      "sid": "string",
      "status": "pending",
      "url": "https://example.com"
    }
  ],
  "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"
  }
}