v50

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

Verify a Passkeys Factor

Verify a Passkeys Factor

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

Path parameters

ServiceSidstring required

The unique SID identifier of the Service.

Request body

idstring

A base64url encoded representation of rawId.

rawIdstring

The globally unique identifier for this PublicKeyCredential.

authenticatorAttachment'platform' | 'cross-platform'

A string that indicates the mechanism by which the WebAuthn implementation is attached to the authenticator at the time the associated navigator.credentials.create() or navigator.credentials.get() call completes.

type'public-key'

The valid credential types supported by the API. The values of this enumeration are used for versioning the AuthenticatorAssertion and AuthenticatorAttestation structures according to the type of the authenticator.

Response

Created

sidstring nullable

A 34 character string that uniquely identifies this Factor.

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

date_createdstring date-time nullable

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

date_updatedstring date-time nullable

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

friendly_namestring nullable

A human readable description of this resource, up to 64 characters.

status'unverified' | 'verified'

The Status of this Factor. One of unverified or verified.

factor_type'push' | 'totp' | 'passkeys'

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

{"stackTrail":"paths:/v2/Services/{ServiceSid}/Passkeys/VerifyFactor:post:responses:200:content:application/json:schema:properties:config","oasType":"schema","type":"unknown","description":"An object that contains configurations specific to a `factor_type`.","extensionFields":{"x-twilio":{"shortDescription":"Configurations for a `factor_type`."}},"nullable":true}
{"stackTrail":"paths:/v2/Services/{ServiceSid}/Passkeys/VerifyFactor:post:responses:200:content:application/json:schema:properties:metadata","oasType":"schema","type":"unknown","description":"Custom metadata associated with the factor.","extensionFields":{"x-twilio":{"shortDescription":"Metadata of the factor.","pii":{"handling":"standard","deleteSla":30}}},"nullable":true}
urlstring uri nullable

The URL of this resource.