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 headers attributes Show headers attributes

  • Twilio-Verify-Signature-Fields string
  • Access-Control-Allow-Origin string

    Specify the origin(s) allowed to access the resource

  • Access-Control-Allow-Methods string

    Specify the HTTP methods allowed when accessing the resource

  • Access-Control-Allow-Headers string

    Specify the headers allowed when accessing the resource

  • Access-Control-Allow-Credentials boolean

    Indicates whether the browser should include credentials

  • Access-Control-Expose-Headers string

    Headers exposed to the client

  Hide response attributes Show response attributes object

  • sid string | null

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

  • account_sid string | null

    The unique SID identifier of the Account.

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

  • service_sid string | null

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

  • entity_sid string | null

    The unique SID identifier of the Entity.

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

  • identity string | null

    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.

  • factor_sid string | null

    The unique SID identifier of the Factor.

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

  • date_created string(date-time) | null

    The date that this Challenge was created, given in ISO 8601 format.

  • date_updated string(date-time) | null

    The date that this Challenge was updated, given in ISO 8601 format.

  • date_responded string(date-time) | null

    The date that this Challenge was responded, given in ISO 8601 format.

  • expiration_date string(date-time) | null

    The date-time when this Challenge expires, given in ISO 8601 format. The default value is five (5) minutes after Challenge creation. The max value is sixty (60) minutes after creation.

  • status string

    The Status of this Challenge. One of pending, expired, approved or denied.

    Values are pending, expired, approved, or denied.

  • responded_reason string

    Reason for the Challenge to be in certain status. One of none, not_needed or not_requested.

    Values are none, not_needed, or not_requested.

  • details

    Details provided to give context about the Challenge. Intended to be shown to the end user.

  • hidden_details

    Details provided to give context about the Challenge. Intended to be hidden from the end user. It must be a stringified JSON with only strings values eg. {"ip": "172.168.1.234"}

  • metadata

    Custom metadata associated with the challenge. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. {"os": "Android"}. Can be up to 1024 characters in length.

  • factor_type string

    The Factor Type of this Challenge. Currently push and totp are supported.

    Values are push or totp.

  • url string(uri) | null

    The URL of this resource.

  • links object(uri-map) | null

    Contains a dictionary of URL links to nested resources of this Challenge.