Twilio/verify

@keeb/twilio/verifyv2026.08.25.2· 16d agoMODELS

01README

Twilio verify API models

02Release Notes

Updated: bucket, entity_challenge, entity_factor, entity, messaging_configuration, rate_limit, service, template, verification_attempt, webhook

03Models21

access_token.tsv2026.08.25.1

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
service_sid	string	yes	Path scope for the access token: service_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
identity	string	yes	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.
factor_type	enum	yes	The Type of the Factor. Currently only `push` is supported.
factor_friendly_name?	string	no	The friendly name of the factor that is going to be created with this access token
ttl?	number	no	How long, in seconds, the access token is valid. Can be an integer between 60 and 300. Default is 60.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a access token

fn get(id: string)

Get a access token

Argument	Type	Required	Description
id	string	yes	The sid of the access token

fn sync()

Sync access token state from Twilio

approve_challenge.tsv2026.08.25.1

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
service_sid	string	yes	Path scope for the approve challenge: service_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
id	string	yes	A [base64url](https://base64.guru/standards/base64url) encoded representation of `rawId`.
raw_id	string	yes	The globally unique identifier for this `PublicKeyCredential`.
authenticator_attachment	enum	yes	A string that indicates the mechanism by which the WebAuthn implementation is attached to the authenticator at the time the associated `navigator.credentials.create()` or `navigator.credentials.get()` call completes.
type?	enum	no	The valid credential types supported by the API. The values of this enumeration are used for versioning the `AuthenticatorAssertion` and `AuthenticatorAttestation` structures according to the type of the authenticator.
response?	object	no	The result of a WebAuthn authentication via a `navigator.credentials.get()` request, as specified in [AuthenticatorAttestationResponse](https://developer.mozilla.org/en-US/docs/Web/API/AuthenticatorAttestationResponse).
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a approve challenge

bucket.tsv2026.08.25.2

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
service_sid	string	yes	Path scope for the bucket: service_sid
rate_limit_sid	string	yes	Path scope for the bucket: rate_limit_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
max	number	yes	Maximum number of requests permitted in during the interval.
interval	number	yes	Number of seconds that the rate limit will be enforced over.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a bucket

fn get(id: string)

Get a bucket

Argument	Type	Required	Description
id	string	yes	The sid of the bucket

fn lookup(max_items?: number)

List buckets and record each as a data artifact (capped at 200 by default; writes a bucket_lookup record with the coverage of the walk)

Argument	Type	Required	Description
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the bucket_lookup record reports truncated: true.

fn update()

Update bucket attributes

fn delete(id: string)

Delete the bucket

Argument	Type	Required	Description
id	string	yes	The sid of the bucket

fn sync()

Sync bucket state from Twilio

Resources

state— Bucket resource state

entity.tsv2026.08.25.2

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
service_sid	string	yes	Path scope for the entity: service_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
identity	string	yes	The unique external identifier for the Entity of the Service. 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.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a entity

fn get(id: string)

Get a entity

Argument	Type	Required	Description
id	string	yes	The identity of the entity

fn lookup(max_items?: number)

List entitys and record each as a data artifact (capped at 200 by default; writes a entity_lookup record with the coverage of the walk)

Argument	Type	Required	Description
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the entity_lookup record reports truncated: true.

fn delete(id: string)

Delete the entity

Argument	Type	Required	Description
id	string	yes	The identity of the entity

fn sync()

Sync entity state from Twilio

Resources

state— Entity resource state

entity_challenge.tsv2026.08.25.2

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
service_sid	string	yes	Path scope for the entity challenge: service_sid
identity	string	yes	Path scope for the entity challenge: identity
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
auth_payload?	string	no	Optional payload used to verify the Challenge upon creation. Only used with a Factor of type `totp` to carry the TOTP code that needs to be verified. For `TOTP` this value must be between 3 and 8 characters long.
metadata?	string	no	Custom metadata associated with the challenge. 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.
factor_sid	string	yes	The unique SID identifier of the Factor.
expiration_date?	string	no	The date-time when this Challenge expires, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. The default value is five (5) minutes after Challenge creation. The max value is sixty (60) minutes after creation.
details_message?	string	no	Shown to the user when the push notification arrives. Required when `factor_type` is `push`. Can be up to 256 characters in length
details_fields?	array	no	A list of objects that describe the Fields included in the Challenge. Each object contains the label and value of the field, the label can be up to 36 characters in length and the value can be up to 128 characters in length. Used when `factor_type` is `push`. There can be up to 20 details fields.
hidden_details?	string	no	Details provided to give context about the Challenge. Not shown to the end user. It must be a stringified JSON with only strings values eg. `{"ip": "172.168.1.234"}`. Can be up to 1024 characters in length
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a entity challenge

fn get(id: string)

Get a entity challenge

Argument	Type	Required	Description
id	string	yes	The sid of the entity challenge

fn lookup(factor_sid?: string, status?: enum, order?: enum, max_items?: number)

List entity challenges and record each as a data artifact (capped at 200 by default; writes a entity_challenge_lookup record with the coverage of the walk)

Argument	Type	Required	Description
factor_sid?	string	no	The unique SID identifier of the Factor.
status?	enum	no	The Status of the Challenges to fetch. One of `pending`, `expired`, `approved` or `denied`.
order?	enum	no	The desired sort order of the Challenges list. One of `asc` or `desc` for ascending and descending respectively. Defaults to `asc`.
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the entity_challenge_lookup record reports truncated: true.

fn update()

Update entity challenge attributes

fn sync()

Sync entity challenge state from Twilio

Resources

state— Entity challenge resource state

entity_factor.tsv2026.08.25.2

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
service_sid	string	yes	Path scope for the entity factor: service_sid
identity	string	yes	Path scope for the entity factor: identity
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
auth_payload?	string	no	The optional payload needed to verify the Factor for the first time. E.g. for a TOTP, the numeric code.
friendly_name	string	yes	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
config_notification_token?	string	no	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_sdk_version?	string	no	The Verify Push SDK version used to configure the factor Required when `factor_type` is `push`
config_time_step?	number	no	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 `f
config_skew?	number	no	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_code_length?	number	no	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_alg?	enum	no
config_notification_platform?	enum	no
factor_type	enum	yes	The Type of this Factor. Currently `push` and `totp` are supported.
binding_alg?	string	no	The algorithm used when `factor_type` is `push`. Algorithm supported: `ES256`
binding_public_key?	string	no	The Ecdsa public key in PKIX, ASN.1 DER format encoded in Base64. Required when `factor_type` is `push`
config_app_id?	string	no	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`.
binding_secret?	string	no	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`
metadata?	string	no	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.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a entity factor

fn get(id: string)

Get a entity factor

Argument	Type	Required	Description
id	string	yes	The sid of the entity factor

fn lookup(max_items?: number)

List entity factors and record each as a data artifact (capped at 200 by default; writes a entity_factor_lookup record with the coverage of the walk)

Argument	Type	Required	Description
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the entity_factor_lookup record reports truncated: true.

fn update()

Update entity factor attributes

fn delete(id: string)

Delete the entity factor

Argument	Type	Required	Description
id	string	yes	The sid of the entity factor

fn sync()

Sync entity factor state from Twilio

Resources

state— Entity factor resource state

form.tsv2026.08.25.1

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
form_type	string	yes	Path scope for the form: form_type
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get(id: string)

Get a form

Argument	Type	Required	Description
id	string	yes	The form_type of the form

fn sync()

Sync form state from Twilio

messaging_configuration.tsv2026.08.25.2

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
service_sid	string	yes	Path scope for the messaging configuration: service_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
messaging_service_sid	string	yes	The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to be used to send SMS to the country of this configuration.
country	string	yes	The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country this configuration will be applied to. If this is a global configuration, Country will take the value `all`.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a messaging configuration

fn get(id: string)

Get a messaging configuration

Argument	Type	Required	Description
id	string	yes	The country of the messaging configuration

fn lookup(max_items?: number)

List messaging configurations and record each as a data artifact (capped at 200 by default; writes a messaging_configuration_lookup record with the coverage of the walk)

Argument	Type	Required	Description
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the messaging_configuration_lookup record reports truncated: true.

fn update()

Update messaging configuration attributes

fn delete(id: string)

Delete the messaging configuration

Argument	Type	Required	Description
id	string	yes	The country of the messaging configuration

fn sync()

Sync messaging configuration state from Twilio

Resources

state— Messaging configuration resource state

notification.tsv2026.08.25.1

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
service_sid	string	yes	Path scope for the notification: service_sid
identity	string	yes	Path scope for the notification: identity
challenge_sid	string	yes	Path scope for the notification: challenge_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
ttl?	number	no	How long, in seconds, the notification is valid. Can be an integer between 0 and 300. Default is 300. Delivery is attempted until the TTL elapses, even if the device is offline. 0 means that the notification delivery is attempted immediately, only once, and is not stored for future delivery.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a notification

passkey_challenge.tsv2026.08.25.1

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
service_sid	string	yes	Path scope for the passkey challenge: service_sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
identity?	string	no
factor_sid?	string	no
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn update()

Update passkey challenge attributes

passkey_factor.tsv2026.08.25.1

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
service_sid	string	yes	Path scope for the passkey factor: service_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
friendly_name	string	yes
identity	string	yes
config?	object	no
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a passkey factor

rate_limit.tsv2026.08.25.2

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
service_sid	string	yes	Path scope for the rate limit: service_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
description?	string	no	Description of this Rate Limit
unique_name	string	yes	Provides a unique and addressable name to be assigned to this Rate Limit, assigned by the developer, to be optionally used in addition to SID. This value should not contain PII.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a rate limit

fn get(id: string)

Get a rate limit

Argument	Type	Required	Description
id	string	yes	The sid of the rate limit

fn lookup(max_items?: number)

List rate limits and record each as a data artifact (capped at 200 by default; writes a rate_limit_lookup record with the coverage of the walk)

Argument	Type	Required	Description
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the rate_limit_lookup record reports truncated: true.

fn update()

Update rate limit attributes

fn delete(id: string)

Delete the rate limit

Argument	Type	Required	Description
id	string	yes	The sid of the rate limit

fn sync()

Sync rate limit state from Twilio

Resources

state— Rate limit resource state

safelist.tsv2026.08.25.1

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
phone_number	string	yes	The phone number to be added in SafeList. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a safelist

fn get(id: string)

Get a safelist

Argument	Type	Required	Description
id	string	yes	The phone_number of the safelist

fn delete(id: string)

Delete the safelist

Argument	Type	Required	Description
id	string	yes	The phone_number of the safelist

fn sync()

Sync safelist state from Twilio

service.tsv2026.08.25.2

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
friendly_name	string	yes	A descriptive string that you create to describe the verification service. It can be up to 32 characters long. This value should not contain PII.
code_length?	number	no	The length of the verification code to generate. Must be an integer value between 4 and 10, inclusive.
lookup_enabled?	boolean	no	Whether to perform a lookup with each verification started and return info about the phone number.
skip_sms_to_landlines?	boolean	no	Whether to skip sending SMS verifications to landlines. Requires `lookup_enabled`.
dtmf_input_required?	boolean	no	Whether to ask the user to press a number before delivering the verify code in a phone call.
tts_name?	string	no	The name of an alternative text-to-speech service to use in phone calls. Applies only to TTS languages.
psd2_enabled?	boolean	no	Whether to pass PSD2 transaction parameters when starting a verification.
do_not_share_warning_enabled?	boolean	no	Whether to add a security warning at the end of an SMS verification body. Disabled by default and applies only to SMS. Example SMS body: `Your AppName verification code is: 1234. Don’t share this code with anyone; our employees will never ask for the code`
custom_code_enabled?	boolean	no	Whether to allow sending verifications with a custom code instead of a randomly generated one.
push_include_date?	boolean	no	Optional configuration for the Push factors. If true, include the date in the Challenge's response. Otherwise, the date is omitted from the response. See [Challenge](https://www.twilio.com/docs/verify/api/challenge) resource’s details parameter for more info. Default: false. Deprecated do not us
push_apn_credential_sid?	string	no	Optional configuration for the Push factors. Set the APN Credential for this service. This will allow to send push notifications to iOS devices. See [Credential Resource](https://www.twilio.com/docs/notify/api/credential-resource)
push_fcm_credential_sid?	string	no	Optional configuration for the Push factors. Set the FCM Credential for this service. This will allow to send push notifications to Android devices. See [Credential Resource](https://www.twilio.com/docs/notify/api/credential-resource)
totp_issuer?	string	no	Optional configuration for the TOTP factors. Set TOTP Issuer for this service. This will allow to configure the issuer of the TOTP URI. Defaults to the service friendly name if not provided.
totp_time_step?	number	no	Optional configuration for the TOTP factors. 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. Defaults to 30 seconds
totp_code_length?	number	no	Optional configuration for the TOTP factors. Number of digits for generated TOTP codes. Must be between 3 and 8, inclusive. Defaults to 6
totp_skew?	number	no	Optional configuration for the TOTP factors. The number of time-steps, past and future, that are valid for validation of TOTP codes. Must be between 0 and 2, inclusive. Defaults to 1
default_template_sid?	string	no	The default message [template](https://www.twilio.com/docs/verify/api/templates). Will be used for all SMS verifications unless explicitly overriden. SMS channel only.
whatsapp_msg_service_sid?	string	no	The SID of the Messaging Service containing WhatsApp Sender(s) that Verify will use to send WhatsApp messages to your users.
whatsapp_from?	string	no	The number to use as the WhatsApp Sender that Verify will use to send WhatsApp messages to your users.This WhatsApp Sender must be associated with a Messaging Service SID.
passkeys_relying_party_id?	string	no	The Relying Party ID for Passkeys. This is the domain of your application, e.g. `example.com`. It is used to identify your application when creating Passkeys.
passkeys_relying_party_name?	string	no	The Relying Party Name for Passkeys. This is the name of your application, e.g. `Example App`. It is used to identify your application when creating Passkeys.
passkeys_relying_party_origins?	string	no	The Relying Party Origins for Passkeys. This is the origin of your application, e.g. `login.example.com,www.example.com`. It is used to identify your application when creating Passkeys, it can have multiple origins split by `,`.
passkeys_authenticator_attachment?	string	no	The Authenticator Attachment for Passkeys. This is the type of authenticator that will be used to create Passkeys. It can be empty or it can have the values `platform`, `cross-platform` or `any`.
passkeys_discoverable_credentials?	string	no	Indicates whether credentials must be discoverable by the authenticator. It can be empty or it can have the values `required`, `preferred` or `discouraged`.
passkeys_user_verification?	string	no	The User Verification for Passkeys. This is the type of user verification that will be used to create Passkeys. It can be empty or it can have the values `required`, `preferred` or `discouraged`.
verify_event_subscription_enabled?	boolean	no	Whether to allow verifications from the service to reach the stream-events sinks if configured
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a service

fn get(id: string)

Get a service

Argument	Type	Required	Description
id	string	yes	The sid of the service

fn lookup(max_items?: number)

List services and record each as a data artifact (capped at 200 by default; writes a service_lookup record with the coverage of the walk)

Argument	Type	Required	Description
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the service_lookup record reports truncated: true.

fn update()

Update service attributes

fn delete(id: string)

Delete the service

Argument	Type	Required	Description
id	string	yes	The sid of the service

fn sync()

Sync service state from Twilio

Resources

state— Service resource state

template.tsv2026.08.25.2

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn lookup(friendly_name?: string, max_items?: number)

List templates and record each as a data artifact (capped at 200 by default; writes a template_lookup record with the coverage of the walk)

Argument	Type	Required	Description
friendly_name?	string	no	String filter used to query templates with a given friendly name.
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the template_lookup record reports truncated: true.

Resources

state— Template resource state

verification.tsv2026.08.25.1

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
service_sid	string	yes	Path scope for the verification: service_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
status?	enum	no	The status of the verification. Can be: `pending`, `approved`, `canceled`, `max_attempts_reached`, `deleted`, `failed` or `expired`.
to	string	yes	The phone number or [email](https://www.twilio.com/docs/verify/email) to verify. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
channel	string	yes	The verification method to use. One of: [`email`](https://www.twilio.com/docs/verify/email), `sms`, `whatsapp`, `call`, `sna` or `auto`.
custom_friendly_name?	string	no	A custom user defined friendly name that overwrites the existing one in the verification message
custom_message?	string	no	The text of a custom message to use for the verification [DEPRECATED].
send_digits?	string	no	The digits to send after a phone call is answered, for example, to dial an extension. For more information, see the Programmable Voice documentation of [sendDigits](https://www.twilio.com/docs/voice/twiml/number#attributes-sendDigits).
locale?	string	no	Locale will automatically resolve based on phone number country code for SMS, WhatsApp, and call channel verifications. It will fallback to English or the template’s default translation if the selected translation is not available. This parameter will override the automatic locale resolution. [See s
custom_code?	string	no	A pre-generated code to use for verification. The code can be between 4 and 10 characters, inclusive.
amount?	string	no	The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
payee?	string	no	The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
rate_limits?	string	no	The custom key-value pairs of Programmable Rate Limits. Keys correspond to `unique_name` fields defined when [creating your Rate Limit](https://www.twilio.com/docs/verify/api/service-rate-limits). Associated value pairs represent values in the request that you are rate limiting on. You may include m
channel_configuration?	string	no	[`email`](https://www.twilio.com/docs/verify/email) channel configuration in json format. The fields 'from' and 'from_name' are optional but if included the 'from' field must have a valid email address.
app_hash?	string	no	Your [App Hash](https://developers.google.com/identity/sms-retriever/verify#computing_your_apps_hash_string) to be appended at the end of your verification SMS body. Applies only to SMS. Example SMS body: `<#> Your AppName verification code is: 1234 He42w354ol9`.
template_sid?	string	no	The message [template](https://www.twilio.com/docs/verify/api/templates). If provided, will override the default template for the Service. SMS and Voice channels only. If the `Templates` parameter is also provided, `Templates` takes precedence over this parameter.
template_custom_substitutions?	string	no	A stringified JSON object in which the keys are the template's special variables and the values are the variables substitutions.
templates?	string	no	A stringified JSON array of template entries, ordered by preference. Each entry is an object with the following fields: `sid` (string, required, matching `^HJ[0-9a-fA-F]{32}$`) — the SID of the message [template](https://www.twilio.com/docs/verify/api/templates) to apply; and `substitutions` (object
device_ip?	string	no	Strongly encouraged if using the auto channel. The IP address of the client's device. If provided, it has to be a valid IPv4 or IPv6 address.
enable_sna_client_token?	boolean	no	An optional Boolean value to indicate the requirement of sna client token in the SNA URL invocation response for added security. This token must match in the Verification Check request to confirm phone number verification.
risk_check?	enum	no	Risk_check overrides Fraud Prevention measures like Fraud Guard, Geo Permissions etc per verification attempt basis, allowing Verify to block traffic considered fraudulent if enabled or bypass active protections if disabled. Can be: `enable`(default) or `disable`. For SMS channel only.
tags?	string	no	A string containing a JSON map of key value pairs of tags to be recorded as metadata for the message. The tags will also be included as part of the verification and message status event type payloads. The object may contain up to 10 tags. Keys and values can each be up to 128 characters in length. *
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a verification

fn get(id: string)

Get a verification

Argument	Type	Required	Description
id	string	yes	The sid of the verification

fn update()

Update verification attributes

fn sync()

Sync verification state from Twilio

verification_attempt.tsv2026.08.25.2

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get(id: string)

Get a verification attempt

Argument	Type	Required	Description
id	string	yes	The sid of the verification attempt

fn lookup(date_created_after?: string, date_created_before?: string, channel_data_to?: string, country?: string, channel?: enum, verify_service_sid?: string, verification_sid?: string, status?: enum, max_items?: number)

List verification attempts and record each as a data artifact (capped at 200 by default; writes a verification_attempt_lookup record with the coverage of the walk)

Argument	Type	Required	Description
date_created_after?	string	no	Datetime filter used to consider only Verification Attempts created after this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.
date_created_before?	string	no	Datetime filter used to consider only Verification Attempts created before this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.
channel_data_to?	string	no	Destination of a verification. It is phone number in E.164 format.
country?	string	no	Filter used to query Verification Attempts sent to the specified destination country.
channel?	enum	no	Filter used to query Verification Attempts by communication channel.
verify_service_sid?	string	no	Filter used to query Verification Attempts by verify service. Only attempts of the provided SID will be returned.
verification_sid?	string	no	Filter used to return all the Verification Attempts of a single verification. Only attempts of the provided verification SID will be returned.
status?	enum	no	Filter used to query Verification Attempts by conversion status. Valid values are `UNCONVERTED`, for attempts that were not converted, and `CONVERTED`, for attempts that were confirmed.
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the verification_attempt_lookup record reports truncated: true.

fn sync()

Sync verification attempt state from Twilio

Resources

state— Verification attempt resource state

verification_attempts_summary.tsv2026.08.25.1

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get()

Get a verification attempts summary

fn sync()

Sync verification attempts summary state from Twilio

verification_check.tsv2026.08.25.1

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
service_sid	string	yes	Path scope for the verification check: service_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
code?	string	no	The 4-10 character string being verified.
to?	string	no	The phone number or [email](https://www.twilio.com/docs/verify/email) to verify. Either this parameter or the `verification_sid` must be specified. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
verification_sid?	string	no	A SID that uniquely identifies the Verification Check. Either this parameter or the `to` phone number/[email](https://www.twilio.com/docs/verify/email) must be specified.
amount?	string	no	The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
payee?	string	no	The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
sna_client_token?	string	no	A sna client token received in sna url invocation response needs to be passed in Verification Check request and should match to get successful response.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a verification check

verify_factor.tsv2026.08.25.1

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
service_sid	string	yes	Path scope for the verify factor: service_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
id?	string	no	A [base64url](https://base64.guru/standards/base64url) encoded representation of `rawId`.
raw_id?	string	no	The globally unique identifier for this `PublicKeyCredential`.
authenticator_attachment?	enum	no	A string that indicates the mechanism by which the WebAuthn implementation is attached to the authenticator at the time the associated `navigator.credentials.create()` or `navigator.credentials.get()` call completes.
type?	enum	no	The valid credential types supported by the API. The values of this enumeration are used for versioning the `AuthenticatorAssertion` and `AuthenticatorAttestation` structures according to the type of the authenticator.
response?	object	no	The result of a WebAuthn credential registration via `navigator.credentials.create()`, as specified in [AuthenticatorAttestationResponse](https://developer.mozilla.org/en-US/docs/Web/API/AuthenticatorAttestationResponse).
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a verify factor

webhook.tsv2026.08.25.2

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
service_sid	string	yes	Path scope for the webhook: service_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
friendly_name	string	yes	The string that you assigned to describe the webhook. This value should not contain PII.
event_types	array	yes	The array of events that this Webhook is subscribed to. Possible event types: `*, factor.deleted, factor.created, factor.verified, challenge.approved, challenge.denied`
webhook_url	string	yes	The URL associated with this Webhook.
status?	enum	no	The webhook status. Default value is `enabled`. One of: `enabled` or `disabled`
version?	enum	no	The webhook version. Default value is `v2` which includes all the latest fields. Version `v1` is legacy and may be removed in the future.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a webhook

fn get(id: string)

Get a webhook

Argument	Type	Required	Description
id	string	yes	The sid of the webhook

fn lookup(max_items?: number)

List webhooks and record each as a data artifact (capped at 200 by default; writes a webhook_lookup record with the coverage of the walk)

Argument	Type	Required	Description
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the webhook_lookup record reports truncated: true.

fn update()

Update webhook attributes

fn delete(id: string)

Delete the webhook

Argument	Type	Required	Description
id	string	yes	The sid of the webhook

fn sync()

Sync webhook state from Twilio

Resources

state— Webhook resource state

04Stats

85 / 100

Downloads

Archive size

94.6 KB

Has README or module doc2/2earned
README has a code example1/1earned
README is substantive1/1earned
Most symbols documented1/1earned
No slow types (deprecated)1/1earned
Dependencies pass trust audit2/2earned
Has description1/1earned
Platform support declared (or universal)2/2earned
License declared1/1earned
Verified public repository0/2missing

05Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64

06Labels

#twilio #verify #communications #saas