v50

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-04-145745483.2 KB
VerifyV2NewChallenge

Create a Passkeys Challenge

Create a Passkeys Challenge

post/v2/Services/{ServiceSid}/Passkeys/Challenges

Path parameters

ServiceSidstring required

The unique SID identifier of the Service.

Request body

identitystring
factor_sidstring

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.

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.

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.

{"stackTrail":"paths:/v2/Services/{ServiceSid}/Passkeys/Challenges:post:responses:201:content:application/json:schema:properties:details","oasType":"schema","type":"unknown","description":"Details provided to give context about the Challenge.","extensionFields":{"x-twilio":{"shortDescription":"Details about the Challenge.","pii":{"handling":"standard","deleteSla":30}}},"nullable":true}
{"stackTrail":"paths:/v2/Services/{ServiceSid}/Passkeys/Challenges:post:responses:201:content:application/json:schema:properties:hidden_details","oasType":"schema","type":"unknown","description":"Details provided to give context about the Challenge.","extensionFields":{"x-twilio":{"shortDescription":"Hidden details about the Challenge","pii":{"handling":"standard","deleteSla":30}}},"nullable":true}
{"stackTrail":"paths:/v2/Services/{ServiceSid}/Passkeys/Challenges:post:responses:201:content:application/json:schema:properties:metadata","oasType":"schema","type":"unknown","description":"Custom metadata associated with the challenge.","extensionFields":{"x-twilio":{"shortDescription":"Metadata of the challenge.","pii":{"handling":"standard","deleteSla":30}}},"nullable":true}
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.

optionsobject

An object that contains challenge options. Currently only used for passkeys.