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. |
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. |
Create a Factor
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 |
friendly_name
Required
|
The friendly name of this Factor |
factor_type
Required
|
The Type of this Factor. Currently only |
binding.alg
Optional
|
The algorithm used when |
binding.public_key
Optional
|
The Ecdsa public key in PKIX, ASN.1 DER format encoded in Base64 |
config.app_id
Optional
|
The ID that uniquely identifies your app in the Google or Apple store, such as |
config.notification_platform
Optional
|
The transport technology used to generate the Notification Token. Can be |
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 |
Example 1
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 |
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 |
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 |
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 |
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 |
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 |
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.