Fetch a specific Factor

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

TODO: Resource-level docs

Fetch a specific 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 Factor. 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.

  • Sid string Required

    A 34 character string that uniquely identifies this Factor.

Responses

  • OK

    Hide response attributes Show response attributes object
    • 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}$.

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

GET /v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid}
curl \
 -X GET https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid} \
 --user "username:password"
Response examples (200)
{
  "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"
}
Response examples (200)
{
  "account_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-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"
}