Retrieve a list of all Factors for an Entity

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

TODO: Resource-level docs

Retrieve a list of all Factors for an Entity.

Path parameters

  • ServiceSid string Required

    The unique SID identifier of the Service.

  • Identity string Required

    Customer unique identity for the Entity owner of the Factors. 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

  • 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
    • factors array[object]
      Hide factors attributes Show factors 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}$.

      • config

        Configurations for a factor_type.

      • date_created string(date-time) | null

        The date this Factor was created

      • date_updated string(date-time) | null

        The date this Factor was updated

      • 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}$.

      • factor_type string | null

        The Type of this Factor

        Values are push or totp.

      • friendly_name string | null

        A human readable description of this resource.

      • identity string | null

        Unique external identifier of the Entity

      • metadata

        Metadata of the factor.

      • 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 Factor.

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

      • status string | null

        The Status of this Factor

        Values are unverified or verified.

      • url string(uri) | null

        The URL of this resource.

    • meta object
      Hide meta attributes Show meta attributes
GET /v2/Services/{ServiceSid}/Entities/{Identity}/Factors 
curl \
 -X GET https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Factors \
 --user "username:password"
Response examples (200) 
{
  "factors": [
    {
      "account_sid": "string",
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "entity_sid": "string",
      "factor_type": "push",
      "friendly_name": "string",
      "identity": "string",
      "service_sid": "string",
      "sid": "string",
      "status": "unverified",
      "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"
  }
}