Factor Resource
Verify Push is in Public Beta.
The Factor resource represents a verification factor/channel. When the factor_type is push, then it contains the metadata for a single registered device. A single Entity contains multiple Factors and a single Factor contains multiple Challenges.
Factor properties
| Resource Properties in REST API format | |
|---|---|
sid
|
A 34 character string that uniquely identifies this Factor. |
account_sid
|
The unique SID identifier of the Account. |
service_sid
|
The unique SID identifier of the Service. |
entity_sid
|
The unique SID identifier of the Entity. |
identity
|
The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, and generated by your external system, such as your user's UUID, GUID, or SID. This value must be between 8 and 64 characters long. |
date_created
|
The date that this Factor was created, given in ISO 8601 format. |
date_updated
|
The date that this Factor was updated, given in ISO 8601 format. |
friendly_name
|
A human readable description of this resource, up to 64 characters. For a push factor, this can be the device's name. |
status
|
The Status of this Factor. One of |
factor_type
|
The Type of this Factor. Currently only |
config
|
An object that contains configurations specific to a |
url
|
The URL of this resource. |
Get a Factor
https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The unique SID identifier of the Service. |
identity
Path
|
Customer unique identity for the Entity owner of the Factor. This value must be between 8 and 64 characters long. |
sid
Path
|
A 34 character string that uniquely identifies this Factor. |
Example 1
List Factors
https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Factors
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The unique SID identifier of the Service. |
identity
Path
|
Customer unique identity for the Entity owner of the Factor. This value must be between 8 and 64 characters long. |
Example 1
Update a Factor
https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The unique SID identifier of the Service. |
identity
Path
|
Customer unique identity for the Entity owner of the Factor. This value must be between 8 and 64 characters long. |
sid
Path
|
A 34 character string that uniquely identifies this Factor. |
auth_payload
Optional
|
The optional payload needed to verify the Factor for the first time. E.g. for a TOTP, the numeric code. |
friendly_name
Optional
|
The new friendly name of this Factor. It can be up to 64 characters. |
config.notification_token
Optional
|
For APN, the device token. For FCM the registration token. It used to send the push notifications. Required when |
config.sdk_version
Optional
|
The Verify Push SDK version used to configure the factor |
config.time_step
Optional
|
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 |
config.skew
Optional
|
The number of time-steps, past and future, that are valid for validation of TOTP codes. Must be between 0 and 2, inclusive |
config.code_length
Optional
|
Number of digits for generated TOTP codes. Must be between 3 and 8, inclusive |
config.alg
Optional
|
The algorithm used to derive the TOTP codes. Can be |
Example 1
Delete a Factor
https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The unique SID identifier of the Service. |
identity
Path
|
Customer unique identity for the Entity owner of the Factor. This value must be between 8 and 64 characters long. |
sid
Path
|
A 34 character string that uniquely identifies this Factor. |
Example 1
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.