TWtwilio
VerifyV2Challenge

Create a new Challenge for the Factor

Changed on

Create a new Challenge for the Factor

post/v2/Services/{ServiceSid}/Entities/{Identity}/Challenges

Request

  • Base URL
    https://verify.twilio.com
  • URL
    https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Challenges
  • Auth
    HTTP basic

Path parameters

ServiceSidstring required

The unique SID identifier of the Service.

Identitystring required

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.

Request body application/x-www-form-urlencoded

FactorSidstring required

The unique SID identifier of the Factor.

ExpirationDatestring date-time

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.

Details.Messagestring

Shown to the user when the push notification arrives. Required when factor_type is push. Can be up to 256 characters in length

HiddenDetailsunknown
AuthPayloadstring

Optional payload used to verify the Challenge upon creation. Only used with a Factor of type totp to carry the TOTP code that needs to be verified. For TOTP this value must be between 3 and 8 characters long.

Response

Created

sidstring nullable

A 34 character string that uniquely identifies this Challenge.

account_sidstring nullable

The unique SID identifier of the Account.

service_sidstring nullable

The unique SID identifier of the Service.

entity_sidstring nullable

The unique SID identifier of the Entity.

identitystring nullable

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_sidstring nullable

The unique SID identifier of the Factor.

date_createdstring date-time nullable

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

date_updatedstring date-time nullable

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

date_respondedstring date-time nullable

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

expiration_datestring date-time nullable

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'pending' | 'expired' | 'approved' | 'denied'

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

responded_reason'none' | 'not_needed' | 'not_requested'

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

detailsunknown
hidden_detailsunknown
metadataunknown
factor_type'push' | 'totp' | 'passkeys'

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

urlstring uri nullable

The URL of this resource.

linksobject nullable

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

Changes

  • v23fd4376faab5Revision changes
    • warning

      added the new passkeys enum value to the response property for the response status

  • v21548692e6804Revision changes
    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • info

      the / request property type was generalized from object to no type

    • info

      the request property type was generalized from object to no type