The Factor resource is currently used by Verify Push and Verify TOTP features. It represents a verification factor/channel. When the factor_type is push, it contains the public key for a single registered device and metadata. When the factor_type is totp, it contains the seed used to generate TOTP codes and metadata. Some Factor properties apply to all factor_types and others do not. A single Entity links to multiple Factors and a single Factor links to multiple Challenges.
For security reasons the binding property is ONLY returned upon creation, and is never returned afterward.
A 34 character string that uniquely identifies this Factor.
^YF[0-9a-fA-F]{32}$Min length: 34Max length: 34The unique SID identifier of the Account.
^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34The unique SID identifier of the Service.
^VA[0-9a-fA-F]{32}$Min length: 34Max length: 34The unique SID identifier of the Entity.
^YE[0-9a-fA-F]{32}$Min length: 34Max length: 34Customer 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.
Contains the factor_type specific secret and metadata.
For push, this is binding.public_key and binding.alg.
For totp, this is binding.secret and binding.uri. The binding.uri property is generated following the google authenticator 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.
The Binding property is ONLY returned upon Factor creation.
The date that this Factor was created, given in ISO 8601 format.
The date that this Factor was updated, given in ISO 8601 format.
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.
The Status of this Factor. One of unverified or verified.
unverifiedverifiedThe Type of this Factor. Currently push and totp are supported.
pushtotpCustom 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.
The URL of this resource.
POST
_10https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Factors
Entity
with the
{Identity}
doesn't exist, it will be created automatically. You do not need to separately create a new Entity before making this request.
Parameters
The unique SID identifier of the Service.
^VA[0-9a-fA-F]{32}$Min length: 34Max length: 34Customer 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.
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.
The Type of this Factor. Currently push and totp are supported.
pushtotpThe algorithm used when factor_type is push. Algorithm supported: ES256
The Ecdsa public key in PKIX, ASN.1 DER format encoded in Base64.
Required when factor_type is push
The ID that uniquely identifies your app in the Google or Apple store, such as com.example.myapp. It can be up to 100 characters long.
Required when factor_type is push.
The transport technology used to generate the Notification Token. Can be apn, fcm or none.
Required when factor_type is push.
apnfcmnoneFor APN, the device token. For FCM, the registration token. It is used to send the push notifications. Must be between 32 and 255 characters long.
Required when factor_type is push.
The Verify Push SDK version used to configure the factor
Required when factor_type is push
The shared secret for TOTP factors encoded in Base32. This can be provided when creating the Factor, otherwise it will be generated.
Used when factor_type is totp
Defines how often, in seconds, are TOTP codes generated. i.e, a new TOTP code is generated every time_step seconds. Must be between 20 and 60 seconds, inclusive. The default value is defined at the service level in the property totp.time_step. Defaults to 30 seconds if not configured.
Used when factor_type is totp
The number of time-steps, past and future, that are valid for validation of TOTP codes. Must be between 0 and 2, inclusive. The default value is defined at the service level in the property totp.skew. If not configured defaults to 1.
Used when factor_type is totp
Number of digits for generated TOTP codes. Must be between 3 and 8, inclusive. The default value is defined at the service level in the property totp.code_length. If not configured defaults to 6.
Used when factor_type is totp
The algorithm used to derive the TOTP codes. Can be sha1, sha256 or sha512. Defaults to sha1.
Used when factor_type is totp
sha1sha256sha512Custom 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.
Example 1
Example 2
GET
_10https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid}
Parameters
The unique SID identifier of the Service.
^VA[0-9a-fA-F]{32}$Min length: 34Max length: 34Customer 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.
A 34 character string that uniquely identifies this Factor.
^YF[0-9a-fA-F]{32}$Min length: 34Max length: 34Example 1
GET
_10https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Factors
Parameters
The unique SID identifier of the Service.
^VA[0-9a-fA-F]{32}$Min length: 34Max length: 34Customer unique identity for the Entity owner of the Factors. 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.
How many resources to return in each list page. The default is 50, and the maximum is 1000.
1Maximum: 1000The page token. This is provided by the API.
Example 1
POST
_10https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid}
Parameters
The unique SID identifier of the Service.
^VA[0-9a-fA-F]{32}$Min length: 34Max length: 34Customer 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.
A 34 character string that uniquely identifies this Factor.
^YF[0-9a-fA-F]{32}$Min length: 34Max length: 34The optional payload needed to verify the Factor for the first time. E.g. for a TOTP, the numeric code.
The new friendly name of this Factor. It can be up to 64 characters.
For APN, the device token. For FCM, the registration token. It is used to send the push notifications. Required when factor_type is push. If specified, this value must be between 32 and 255 characters long.
Defines how often, in seconds, are TOTP codes generated. i.e, a new TOTP code is generated every time_step seconds. Must be between 20 and 60 seconds, inclusive
The number of time-steps, past and future, that are valid for validation of TOTP codes. Must be between 0 and 2, inclusive
Number of digits for generated TOTP codes. Must be between 3 and 8, inclusive
The algorithm used to derive the TOTP codes. Can be sha1, sha256 or sha512
sha1sha256sha512The transport technology used to generate the Notification Token. Can be apn, fcm or none.
Required when factor_type is push.
Example 1
Increases time step and code length
DELETE
_10https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid}
Parameters
The unique SID identifier of the Service.
^VA[0-9a-fA-F]{32}$Min length: 34Max length: 34Customer 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.
A 34 character string that uniquely identifies this Factor.
^YF[0-9a-fA-F]{32}$Min length: 34Max length: 34Example 1