Path parameters

• ServiceSid string Required

  The unique SID identifier of the Service.

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

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

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

Responses

• 200 application/json

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

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