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 Challenges. 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 Challenge.

  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^YC[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}$.

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