v1

latestOpenAPI 3.0.1Apache 2.02026-07-145344123.3 KB

Create a new Factor for the Entity

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

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.

Response

Created

account_sidstring nullable

The unique SID identifier of the Account.

{"stackTrail":"components:schemas:verify.v2.service.entity.new_factor:properties:binding","oasType":"schema","type":"unknown","description":"Contains the `factor_type` specific secret and metadata.\nFor push, this is `binding.public_key` and `binding.alg`.\nFor totp, this is `binding.secret` and `binding.uri`. The `binding.uri` property is generated following the [google authenticator key URI format](https://github.com/google/google-authenticator/wiki/Key-Uri-Format), and `Factor.friendly_name` is used for the “accountname” value and `Service.friendly_name` or `Service.totp.issuer` is used for the `issuer` value.\n\n\nThe Binding property is ONLY returned upon Factor creation.","nullable":true}
{"stackTrail":"components:schemas:verify.v2.service.entity.new_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

The friendly name of this Factor. This can be any string up to 64 characters, meant for humans to distinguish between Factors. For factor_type push, this could be a device name. For factor_type totp, this value is used as the “account name” in constructing the binding.uri property. At the same time, we recommend avoiding providing PII.

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