Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-145344123.3 KB

Update a specific Factor. This endpoint can be used to Verify a Factor if passed an AuthPayload param.

post/v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid}

Path parameters

ServiceSidstring required

The unique SID identifier of the Service.

Identitystring required

Customer unique identity for the Entity owner of the Factor. 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.

Sidstring required

A 34 character string that uniquely identifies this Factor.

Response

OK

account_sidstring nullable

The unique SID identifier of the Account.

{"stackTrail":"components:schemas:verify.v2.service.entity.factor:properties:config","oasType":"schema","type":"unknown","description":"An object that contains configurations specific to a `factor_type`.","nullable":true}
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.

entity_sidstring nullable

The unique SID identifier of the Entity.

factor_type'push' | 'totp'
friendly_namestring nullable

A human readable description of this resource, up to 64 characters. For a push factor, this can be the device's name.

identitystring nullable

Customer unique identity for the Entity owner of the Factor. 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.

{"stackTrail":"components:schemas:verify.v2.service.entity.factor:properties:metadata","oasType":"schema","type":"unknown","description":"Custom metadata associated with the factor. 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.","nullable":true}
service_sidstring nullable

The unique SID identifier of the Service.

sidstring nullable

A 34 character string that uniquely identifies this Factor.

status'unverified' | 'verified'
urlstring uri nullable

The URL of this resource.