Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Factor Resource


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.


Factor Properties

factor-properties page anchor
(information)

Info

For security reasons the binding property is ONLY returned upon creation, and is never returned afterward.

sidSID<YF>
Not PII

A 34 character string that uniquely identifies this Factor.

Pattern: ^YF[0-9a-fA-F]{32}$Min length: 34Max length: 34

account_sidSID<AC>

The unique SID identifier of the Account.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

service_sidSID<VA>

The unique SID identifier of the Service.

Pattern: ^VA[0-9a-fA-F]{32}$Min length: 34Max length: 34

entity_sidSID<YE>

The unique SID identifier of the Entity.

Pattern: ^YE[0-9a-fA-F]{32}$Min length: 34Max length: 34

identitystring
PII MTL: 30 days

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.


bindingobject

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(link takes you to an external page), 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.


date_createdstring<date-time>

The date that this Factor was created, given in ISO 8601(link takes you to an external page) format.


date_updatedstring<date-time>

The date that this Factor was updated, given in ISO 8601(link takes you to an external page) format.


friendly_namestring

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.


statusenum<string>

The Status of this Factor. One of unverified or verified.

Possible values:
unverifiedverified

factor_typeenum<string>

The Type of this Factor. Currently push and totp are supported.

Possible values:
pushtotp

configobject

An object that contains configurations specific to a factor_type.


metadataobject

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.


urlstring<uri>

The URL of this resource.


Create a new Factor resource

create-a-new-factor-resource page anchor

POST


_10
https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Factors

(information)

Info

  • Unverified Factors will be deleted and unverifiable after 1-24 hours from when they were created. This is done for security and clean-up reasons.
  • In the request, if the specified 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

Path parameters

path-parameters page anchor
ServiceSidSID<VA>required

The unique SID identifier of the Service.

Pattern: ^VA[0-9a-fA-F]{32}$Min length: 34Max length: 34

Identitystringrequired

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.

FriendlyNamestringrequired

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.


FactorTypeenum<string>required

The Type of this Factor. Currently push and totp are supported.

Possible values:
pushtotp

Binding.Algstring

The algorithm used when factor_type is push. Algorithm supported: ES256


Binding.PublicKeystring

The Ecdsa public key in PKIX, ASN.1 DER format encoded in Base64.

Required when factor_type is push


Config.AppIdstring

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.


Config.NotificationPlatformenum<string>

The transport technology used to generate the Notification Token. Can be apn, fcm or none.

Required when factor_type is push.

Possible values:
apnfcmnone

Config.NotificationTokenstring

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


Config.SdkVersionstring

The Verify Push SDK version used to configure the factor

Required when factor_type is push


Binding.Secretstring

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


Config.TimeStepinteger

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


Config.Skewinteger

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


Config.CodeLengthinteger

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


Config.Algenum<string>

The algorithm used to derive the TOTP codes. Can be sha1, sha256 or sha512. Defaults to sha1.

Used when factor_type is totp

Possible values:
sha1sha256sha512

Metadataobject

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.

Example 1

Create New Push Factor

create-new-push-factor page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_21
// Download the helper library from https://www.twilio.com/docs/node/install
_21
// Find your Account SID and Auth Token at twilio.com/console
_21
// and set the environment variables. See http://twil.io/secure
_21
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_21
const authToken = process.env.TWILIO_AUTH_TOKEN;
_21
const client = require('twilio')(accountSid, authToken);
_21
_21
client.verify.v2.services('VAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_21
.entities('ff483d1ff591898a9942916050d2ca3f')
_21
.newFactors
_21
.create({
_21
'binding.alg': 'ES256',
_21
'binding.publicKey': 'dGVzdF9rZXk=',
_21
'config.appId': 'com.example.myapp',
_21
'config.sdkVersion': '1.0.0',
_21
'config.notificationPlatform': 'fcm',
_21
'config.notificationToken': 'test_token',
_21
friendlyName: `John's Phone`,
_21
factorType: 'push'
_21
})
_21
.then(new_factor => console.log(new_factor.sid));

Output

_26
{
_26
"sid": "YFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_26
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_26
"service_sid": "VAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_26
"entity_sid": "YEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_26
"identity": "ff483d1ff591898a9942916050d2ca3f",
_26
"binding": {
_26
"alg": "ES256",
_26
"public_key": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE8GdwtibWe0kpgsFl6xPQBwhtwUEyeJkeozFmi2jiJDzxFSMwVy3kVR1h/dPVYOfgkC0EkfBRJ0J/6xW47FD5vA=="
_26
},
_26
"date_created": "2015-07-30T20:00:00Z",
_26
"date_updated": "2015-07-30T20:00:00Z",
_26
"friendly_name": "John's Phone",
_26
"status": "unverified",
_26
"factor_type": "push",
_26
"config": {
_26
"sdk_version": "1.0",
_26
"app_id": "com.example.myapp",
_26
"notification_platform": "fcm",
_26
"notification_token": "test_token"
_26
},
_26
"metadata": {
_26
"os": "Android"
_26
},
_26
"url": "https://verify.twilio.com/v2/Services/VAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_26
}

Example 2

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_20
// Download the helper library from https://www.twilio.com/docs/node/install
_20
// Find your Account SID and Auth Token at twilio.com/console
_20
// and set the environment variables. See http://twil.io/secure
_20
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_20
const authToken = process.env.TWILIO_AUTH_TOKEN;
_20
const client = require('twilio')(accountSid, authToken);
_20
_20
client.verify.v2.services('VAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_20
.entities('ff483d1ff591898a9942916050d2ca3f')
_20
.newFactors
_20
.create({
_20
'binding.secret': 'GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ',
_20
'config.alg': 'sha1',
_20
'config.timeStep': 30,
_20
'config.codeLength': 6,
_20
'config.skew': 1,
_20
friendlyName: `John's Phone`,
_20
factorType: 'totp'
_20
})
_20
.then(new_factor => console.log(new_factor.sid));

Output

_24
{
_24
"sid": "YFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_24
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_24
"service_sid": "VAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_24
"entity_sid": "YEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_24
"identity": "ff483d1ff591898a9942916050d2ca3f",
_24
"binding": {
_24
"secret": "GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ",
_24
"uri": "otpauth://totp/test-issuer:John%E2%80%99s%20Account%20Name?secret=GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ&issuer=test-issuer&algorithm=SHA1&digits=6&period=30"
_24
},
_24
"date_created": "2015-07-30T20:00:00Z",
_24
"date_updated": "2015-07-30T20:00:00Z",
_24
"friendly_name": "John's Phone",
_24
"status": "unverified",
_24
"factor_type": "totp",
_24
"config": {
_24
"alg": "sha1",
_24
"skew": 1,
_24
"code_length": 6,
_24
"time_step": 30
_24
},
_24
"metadata": null,
_24
"url": "https://verify.twilio.com/v2/Services/VAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_24
}


GET


_10
https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid}

Parameters

ServiceSidSID<VA>required

The unique SID identifier of the Service.

Pattern: ^VA[0-9a-fA-F]{32}$Min length: 34Max length: 34

Identitystringrequired

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.


SidSID<YF>required

A 34 character string that uniquely identifies this Factor.

Pattern: ^YF[0-9a-fA-F]{32}$Min length: 34Max length: 34

Example 1

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_12
// Download the helper library from https://www.twilio.com/docs/node/install
_12
// Find your Account SID and Auth Token at twilio.com/console
_12
// and set the environment variables. See http://twil.io/secure
_12
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12
const authToken = process.env.TWILIO_AUTH_TOKEN;
_12
const client = require('twilio')(accountSid, authToken);
_12
_12
client.verify.v2.services('VAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12
.entities('identity')
_12
.factors('YFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12
.fetch()
_12
.then(factor => console.log(factor.friendlyName));

Output

_22
{
_22
"sid": "YFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_22
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_22
"service_sid": "VAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_22
"entity_sid": "YEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_22
"identity": "ff483d1ff591898a9942916050d2ca3f",
_22
"date_created": "2015-07-30T20:00:00Z",
_22
"date_updated": "2015-07-30T20:00:00Z",
_22
"friendly_name": "friendly_name",
_22
"status": "unverified",
_22
"factor_type": "push",
_22
"config": {
_22
"sdk_version": "1.0",
_22
"app_id": "com.example.myapp",
_22
"notification_platform": "fcm",
_22
"notification_token": "test_token"
_22
},
_22
"metadata": {
_22
"os": "Android"
_22
},
_22
"url": "https://verify.twilio.com/v2/Services/VAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_22
}


Read multiple Factor resources

read-multiple-factor-resources page anchor

GET


_10
https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Factors

Parameters

ServiceSidSID<VA>required

The unique SID identifier of the Service.

Pattern: ^VA[0-9a-fA-F]{32}$Min length: 34Max length: 34

Identitystringrequired

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

PageSizeinteger

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum: 1Maximum: 1000

Pageinteger

The page index. This value is simply for client state.

Minimum: 0

PageTokenstring

The page token. This is provided by the API.

Example 1

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_12
// Download the helper library from https://www.twilio.com/docs/node/install
_12
// Find your Account SID and Auth Token at twilio.com/console
_12
// and set the environment variables. See http://twil.io/secure
_12
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12
const authToken = process.env.TWILIO_AUTH_TOKEN;
_12
const client = require('twilio')(accountSid, authToken);
_12
_12
client.verify.v2.services('VAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12
.entities('ff483d1ff591898a9942916050d2ca3f')
_12
.factors
_12
.list({limit: 20})
_12
.then(factors => factors.forEach(f => console.log(f.sid)));

Output

_35
{
_35
"factors": [
_35
{
_35
"sid": "YFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_35
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_35
"service_sid": "VAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_35
"entity_sid": "YEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_35
"identity": "ff483d1ff591898a9942916050d2ca3f",
_35
"date_created": "2015-07-30T20:00:00Z",
_35
"date_updated": "2015-07-30T20:00:00Z",
_35
"friendly_name": "friendly_name",
_35
"status": "unverified",
_35
"factor_type": "push",
_35
"config": {
_35
"sdk_version": "1.0",
_35
"app_id": "com.example.myapp",
_35
"notification_platform": "fcm",
_35
"notification_token": "test_token"
_35
},
_35
"metadata": {
_35
"os": "Android"
_35
},
_35
"url": "https://verify.twilio.com/v2/Services/VAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_35
}
_35
],
_35
"meta": {
_35
"page": 0,
_35
"page_size": 50,
_35
"first_page_url": "https://verify.twilio.com/v2/Services/VAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0",
_35
"previous_page_url": "https://verify.twilio.com/v2/Services/VAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0",
_35
"url": "https://verify.twilio.com/v2/Services/VAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0",
_35
"next_page_url": "https://verify.twilio.com/v2/Services/VAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=1",
_35
"key": "factors"
_35
}
_35
}


Update a Factor resource

update-a-factor-resource page anchor

POST


_10
https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid}

Parameters

ServiceSidSID<VA>required

The unique SID identifier of the Service.

Pattern: ^VA[0-9a-fA-F]{32}$Min length: 34Max length: 34

Identitystringrequired

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.


SidSID<YF>required

A 34 character string that uniquely identifies this Factor.

Pattern: ^YF[0-9a-fA-F]{32}$Min length: 34Max length: 34
AuthPayloadstring

The optional payload needed to verify the Factor for the first time. E.g. for a TOTP, the numeric code.


FriendlyNamestring

The new friendly name of this Factor. It can be up to 64 characters.


Config.NotificationTokenstring

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.


Config.SdkVersionstring

The Verify Push SDK version used to configure the factor


Config.TimeStepinteger

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

The number of time-steps, past and future, that are valid for validation of TOTP codes. Must be between 0 and 2, inclusive


Config.CodeLengthinteger

Number of digits for generated TOTP codes. Must be between 3 and 8, inclusive


Config.Algenum<string>

The algorithm used to derive the TOTP codes. Can be sha1, sha256 or sha512

Possible values:
sha1sha256sha512

Config.NotificationPlatformstring

The transport technology used to generate the Notification Token. Can be apn, fcm or none.

Required when factor_type is push.

Example 1

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_12
// Download the helper library from https://www.twilio.com/docs/node/install
_12
// Find your Account SID and Auth Token at twilio.com/console
_12
// and set the environment variables. See http://twil.io/secure
_12
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12
const authToken = process.env.TWILIO_AUTH_TOKEN;
_12
const client = require('twilio')(accountSid, authToken);
_12
_12
client.verify.v2.services('VAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12
.entities('ff483d1ff591898a9942916050d2ca3f')
_12
.factors('YFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12
.update({authPayload: '724590'})
_12
.then(factor => console.log(factor.friendlyName));

Output

_22
{
_22
"sid": "YFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_22
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_22
"service_sid": "VAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_22
"entity_sid": "YEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_22
"identity": "ff483d1ff591898a9942916050d2ca3f",
_22
"date_created": "2015-07-30T20:00:00Z",
_22
"date_updated": "2015-07-30T20:00:00Z",
_22
"friendly_name": "friendly_name",
_22
"status": "verified",
_22
"factor_type": "push",
_22
"config": {
_22
"sdk_version": "1.0",
_22
"app_id": "com.example.myapp",
_22
"notification_platform": "fcm",
_22
"notification_token": "test_token"
_22
},
_22
"metadata": {
_22
"os": "Android"
_22
},
_22
"url": "https://verify.twilio.com/v2/Services/VAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_22
}

Update a TOTP factor settings

update-a-totp-factor-settings page anchor

Increases time step and code length

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_12
// Download the helper library from https://www.twilio.com/docs/node/install
_12
// Find your Account SID and Auth Token at twilio.com/console
_12
// and set the environment variables. See http://twil.io/secure
_12
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12
const authToken = process.env.TWILIO_AUTH_TOKEN;
_12
const client = require('twilio')(accountSid, authToken);
_12
_12
client.verify.v2.services('VAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12
.entities('ff483d1ff591898a9942916050d2ca3f')
_12
.factors('YFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12
.update({'config.codeLength': 8, 'config.timeStep': 45})
_12
.then(factor => console.log(factor.config));

Output

_22
{
_22
"sid": "YFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_22
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_22
"service_sid": "VAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_22
"entity_sid": "YEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_22
"identity": "ff483d1ff591898a9942916050d2ca3f",
_22
"date_created": "2015-07-30T20:00:00Z",
_22
"date_updated": "2015-07-30T20:00:00Z",
_22
"friendly_name": "friendly_name",
_22
"status": "verified",
_22
"factor_type": "push",
_22
"config": {
_22
"sdk_version": "1.0",
_22
"app_id": "com.example.myapp",
_22
"notification_platform": "fcm",
_22
"notification_token": "test_token"
_22
},
_22
"metadata": {
_22
"os": "Android"
_22
},
_22
"url": "https://verify.twilio.com/v2/Services/VAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_22
}


Delete a Factor resource

delete-a-factor-resource page anchor

DELETE


_10
https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid}

Parameters

ServiceSidSID<VA>required

The unique SID identifier of the Service.

Pattern: ^VA[0-9a-fA-F]{32}$Min length: 34Max length: 34

Identitystringrequired

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.


SidSID<YF>required

A 34 character string that uniquely identifies this Factor.

Pattern: ^YF[0-9a-fA-F]{32}$Min length: 34Max length: 34

Example 1

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_11
// Download the helper library from https://www.twilio.com/docs/node/install
_11
// Find your Account SID and Auth Token at twilio.com/console
_11
// and set the environment variables. See http://twil.io/secure
_11
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11
const authToken = process.env.TWILIO_AUTH_TOKEN;
_11
const client = require('twilio')(accountSid, authToken);
_11
_11
client.verify.v2.services('VAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11
.entities('ff483d1ff591898a9942916050d2ca3f')
_11
.factors('YFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11
.remove();


Rate this page: