Twilio/trusthub

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

01README

Twilio trusthub API models

02Release Notes

Updated: customer_profile, customer_profiles_channel_endpoint_assignment, customer_profiles_entity_assignment, customer_profiles_evaluation, end_user_type, end_user, policy, supporting_document_type, supporting_document, trust_product, trust_products_channel_endpoint_assignment, trust_products_entity_assignment, trust_products_evaluation

03Models24

a2p_brand_registration.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)
brand_type	enum	yes	The type of brand being registered.
theme_set_id?	string	no	Theme ID for styling the inquiry form.
friendly_name?	string	no	A human-readable name for the brand registration.
notification_email	string	yes	The email address to receive notifications about the registration.
business_name?	string	no	The legal name of the business.
business_registration_authority?	string	no	The authority with which the business is registered.
business_registration_number?	string	no	The business registration number (e.g., EIN, CBN, ACN). Maximum 21 characters.
business_industry?	string	no	The industry of the business.
business_website?	string	no	The business website URL (must use https://).
business_type?	string	no	The type of business entity.
business_stock_symbol?	string	no	The stock symbol for publicly traded companies.
business_stock_exchange?	string	no	The stock exchange where the business is listed.
business_tax_exempt_status?	string	no	Nonprofit/political organization tax-exempt status per the U.S. tax code (e.g. 501c3, 501c1, 527). A value of 527 (political organization) requires a Campaign Verify token in brandExternalVettingToken.
brand_external_vetting_token?	string	no	Campaign Verify token for externally vetted brands.
business_street_address?	string	no	The street address of the business.
business_street_address2?	string	no	Additional street address information.
business_city?	string	no	The city of the business.
business_state_province_region?	string	no	The state, province, or region of the business.
business_postal_code?	string	no	The postal code of the business.
business_country?	string	no	The two-letter ISO country code of the business.
business_contact_first_name?	string	no	The first name of the business contact.
business_contact_last_name?	string	no	The last name of the business contact.
business_contact_email?	string	no	The email address of the business contact.
business_contact_phone?	string	no	The phone number of the business contact in E.164 format.
authorized_contact_verification_email?	string	no	The email address for authorized contact verification.
authorized_contact_mobile_phone_number_e164?	string	no	The mobile phone number for authorized contact in E.164 format.
is_test?	boolean	no	Whether this is a test brand registration.
skip_automatic_sec_vet?	boolean	no	Whether to skip automatic secondary vetting.
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 a2p brand registration

a2p_brand_registration_embedded_session.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.
id	string	yes	Path scope for the a2p brand registration embedded session: id
name	string	yes	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 create()

Create a a2p brand registration embedded session

a2p_campaign_registration.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)
a2p_brand_registration_sid	string	yes	The legacy Twilio A2P Brand SID (BN-prefixed) for the brand this campaign is registered under. This is a different identifier from the `id` returned by the Initialize Brand endpoint (which is formatted as `tri1.us1.account.AC.../registration.BU...`). Retrieve the BN brand SID via [GET /v1/a2p/BrandR
messaging_service_sid?	string	no	The SID of the Messaging Service.
theme_set_id?	string	no	Theme ID for styling the inquiry form.
use_case_categories?	array	no	The categories of the messaging use case.
use_case_description?	string	no	A description of the messaging use case.
use_case_sample_message1?	string	no	A sample message for the use case.
use_case_sample_message2?	string	no	A second sample message for the use case.
use_case_sample_message3?	string	no	A third sample message for the use case.
use_case_sample_message4?	string	no	A fourth sample message for the use case.
use_case_sample_message5?	string	no	A fifth sample message for the use case.
use_case_opt_in_types?	array	no	The opt-in methods for the use case.
use_case_opt_in_description?	string	no	A description of the opt-in process.
has_embedded_links?	boolean	no	Whether messages will contain embedded links.
has_embedded_phone?	boolean	no	Whether messages will contain embedded phone numbers.
embedded_url_sample?	string	no	A sample URL that will be embedded in messages (must use https://).
direct_lending?	boolean	no	Whether the campaign involves direct lending.
age_gated?	boolean	no	Whether the content is age-gated.
privacy_policy_url?	string	no	The URL to the privacy policy.
terms_and_conditions_url?	string	no	The URL to the terms and conditions.
opt_in_keywords?	array	no	Keywords users can text to opt in.
opt_in_message_sample?	string	no	A sample opt-in confirmation message.
opt_out_keywords?	array	no	Keywords users can text to opt out.
opt_out_message_sample?	string	no	A sample opt-out confirmation message.
help_keywords?	array	no	Keywords users can text for help.
help_message_sample?	string	no	A sample help message.
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 a2p campaign registration

a2p_campaign_registration_embedded_session.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.
id	string	yes	Path scope for the a2p campaign registration embedded session: id
name	string	yes	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 create()

Create a a2p campaign registration embedded session

compliance_inquiry.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)
notification_email?	string	no	The email address that approval status updates will be sent to. If not specified, the email address associated with your primary customer profile will be used.
theme_set_id?	string	no	Theme id for styling the inquiry form.
primary_profile_sid?	string	no	The unique SID identifier of the Primary Customer Profile that should be used as a parent. Only necessary when creating a secondary Customer Profile.
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 compliance inquiry

compliance_registration_inquiry.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)
end_user_type	enum	yes	The type of End User the regulation requires - can be `Individual` or `Business`.
phone_number_type	enum	yes	The type of phone number of the Bundle's ownership request. Can be `local`, `mobile`, `national`, or `toll-free`.
business_identity_type?	enum	no	The type of business identity. Can be `direct customer` or `ISV`.
business_registration_authority?	enum	no	The authority that registered the business
business_legal_name?	string	no	he name of the business or organization using the Tollfree number.
notification_email?	string	no	he email address to receive the notification about the verification result.
accepted_notification_receipt?	boolean	no	The email address to receive the notification about the verification result.
business_registration_number?	string	no	Business registration number of the business
business_website_url?	string	no	The URL of the business website
friendly_name?	string	no	Friendly name for your business information
authorized_representative1_first_name?	string	no	First name of the authorized representative
authorized_representative1_last_name?	string	no	Last name of the authorized representative
authorized_representative1_phone?	string	no	Phone number of the authorized representative
authorized_representative1_email?	string	no	Email address of the authorized representative
authorized_representative1_date_of_birth?	string	no	Birthdate of the authorized representative
address_street?	string	no	Street address of the business
address_street_secondary?	string	no	Street address of the business
address_city?	string	no	City of the business
address_subdivision?	string	no	State or province of the business
address_postal_code?	string	no	Postal code of the business
address_country_code?	string	no	Country code of the business
emergency_address_street?	string	no	Street address of the business
emergency_address_street_secondary?	string	no	Street address of the business
emergency_address_city?	string	no	City of the business
emergency_address_subdivision?	string	no	State or province of the business
emergency_address_postal_code?	string	no	Postal code of the business
emergency_address_country_code?	string	no	Country code of the business
use_address_as_emergency_address?	boolean	no	Use the business address as the emergency address
file_name?	string	no	The name of the verification document to upload
file?	string	no	The verification document to upload
first_name?	string	no	The first name of the Individual User.
last_name?	string	no	The last name of the Individual User.
date_of_birth?	string	no	The date of birth of the Individual User.
individual_email?	string	no	The email address of the Individual User.
individual_phone?	string	no	The phone number of the Individual User.
is_isv_embed?	boolean	no	Indicates if the inquiry is being started from an ISV embedded component.
isv_registering_for_self_or_tenant?	string	no	Indicates if the isv registering for self or tenant.
status_callback_url?	string	no	The url we call to inform you of bundle changes.
theme_set_id?	string	no	Theme id for styling the inquiry form.
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 compliance registration inquiry

compliance_tollfree_inquiry.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)
tollfree_phone_number	string	yes	The Tollfree phone number to be verified
notification_email	string	yes	The email address to receive the notification about the verification result.
customer_profile_sid?	string	no	The Customer Profile Sid associated with the Account.
business_name?	string	no	The name of the business or organization using the Tollfree number.
business_website?	string	no	The website of the business or organization using the Tollfree number.
use_case_categories?	array	no	The category of the use case for the Tollfree Number. List as many are applicable..
use_case_summary?	string	no	Use this to further explain how messaging is used by the business or organization.
production_message_sample?	string	no	An example of message content, i.e. a sample message.
opt_in_image_urls?	array	no	Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL.
opt_in_type?	enum	no	Describe how a user opts-in to text messages.
message_volume?	string	no	Estimate monthly volume of messages from the Tollfree Number.
business_street_address?	string	no	The address of the business or organization using the Tollfree number.
business_street_address2?	string	no	The address of the business or organization using the Tollfree number.
business_city?	string	no	The city of the business or organization using the Tollfree number.
business_state_province_region?	string	no	The state/province/region of the business or organization using the Tollfree number.
business_postal_code?	string	no	The postal code of the business or organization using the Tollfree number.
business_country?	string	no	The country of the business or organization using the Tollfree number.
additional_information?	string	no	Additional information to be provided for verification.
business_contact_first_name?	string	no	The first name of the contact for the business or organization using the Tollfree number.
business_contact_last_name?	string	no	The last name of the contact for the business or organization using the Tollfree number.
business_contact_email?	string	no	The email address of the contact for the business or organization using the Tollfree number.
business_contact_phone?	string	no	The phone number of the contact for the business or organization using the Tollfree number.
theme_set_id?	string	no	Theme id for styling the inquiry form.
skip_messaging_use_case?	boolean	no	Skip the messaging use case screen of the inquiry form.
business_registration_number?	string	no	The Business Registration Number of the business or organization.
business_registration_authority?	string	no	The Business Registration Authority of the business or organization.
business_registration_country?	string	no	The Business Registration Country of the business or organization.
business_type?	enum	no	Type of Business.
doing_business_as?	string	no	Trade name, sub entity, or downstream business name of business being submitted for verification.
opt_in_confirmation_message?	string	no	The confirmation message sent to users when they opt in to receive messages.
help_message_sample?	string	no	A sample help message provided to users.
privacy_policy_url?	string	no	The URL to the privacy policy for the business or organization.
terms_and_conditions_url?	string	no	The URL to the terms and conditions for the business or organization.
age_gated_content?	boolean	no	Indicates if the content is age gated.
external_reference_id?	string	no	A legally recognized business registration number.
opt_in_keywords?	array	no	List of keywords that users can text in to opt in to receive messages.
vetting_id?	string	no	Unique identifier for the created Vetting .
vetting_provider?	string	no	Name of the vetting provider.
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 compliance tollfree inquiry

customer_compliance_inquiry.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.
customer_id	string	yes	Path scope for the customer compliance inquiry: customer_id
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
primary_profile_sid	string	yes	The unique SID identifier of the Primary Customer Profile that should be used as a parent. Only necessary when creating a secondary Customer Profile.
theme_set_id?	string	no	Theme id for styling the inquiry form.
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 customer compliance inquiry attributes

customer_profile.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)
status?	enum	no	The verification status of the Customer-Profile resource.
status_callback?	string	no	The URL we call to inform your application of status changes.
friendly_name	string	yes	The string that you assigned to describe the resource.
email	string	yes	The email address that will receive updates when the Customer-Profile resource changes status.
policy_sid	string	yes	The unique string of a policy that is associated to the Customer-Profile resource.
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 customer profile

fn get(id: string)

Get a customer profile

Argument	Type	Required	Description
id	string	yes	The sid of the customer profile

fn lookup(status?: enum, friendly_name?: string, policy_sid?: string, max_items?: number)

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

Argument	Type	Required	Description
status?	enum	no	The verification status of the Customer-Profile resource.
friendly_name?	string	no	The string that you assigned to describe the resource.
policy_sid?	string	no	The unique string of a policy that is associated to the Customer-Profile resource.
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 customer_profile_lookup record reports truncated: true.

fn update()

Update customer profile attributes

fn delete(id: string)

Delete the customer profile

Argument	Type	Required	Description
id	string	yes	The sid of the customer profile

fn sync()

Sync customer profile state from Twilio

Resources

state— Customer profile resource state

customer_profiles_channel_endpoint_assignment.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.
customer_profile_sid	string	yes	Path scope for the customer profiles channel endpoint assignment: customer_profile_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
channel_endpoint_type	string	yes	The type of channel endpoint. eg: phone-number
channel_endpoint_sid	string	yes	The SID of an channel endpoint
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 customer profiles channel endpoint assignment

fn get(id: string)

Get a customer profiles channel endpoint assignment

Argument	Type	Required	Description
id	string	yes	The sid of the customer profiles channel endpoint assignment

fn lookup(channel_endpoint_sid?: string, channel_endpoint_sids?: string, max_items?: number)

List customer profiles channel endpoint assignments and record each as a data artifact (capped at 200 by default; writes a customer_profiles_channel_endpoint_assignment_lookup record with the coverage of the walk)

Argument	Type	Required	Description
channel_endpoint_sid?	string	no	The SID of an channel endpoint
channel_endpoint_sids?	string	no	comma separated list of channel endpoint sids
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 customer_profiles_channel_endpoint_assignment_lookup record reports truncated: true.

fn delete(id: string)

Delete the customer profiles channel endpoint assignment

Argument	Type	Required	Description
id	string	yes	The sid of the customer profiles channel endpoint assignment

fn sync()

Sync customer profiles channel endpoint assignment state from Twilio

Resources

state— Customer profiles channel endpoint assignment resource state

customer_profiles_entity_assignment.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.
customer_profile_sid	string	yes	Path scope for the customer profiles entity assignment: customer_profile_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
object_sid	string	yes	The SID of an object bag that holds information of the different items.
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 customer profiles entity assignment

fn get(id: string)

Get a customer profiles entity assignment

Argument	Type	Required	Description
id	string	yes	The sid of the customer profiles entity assignment

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

List customer profiles entity assignments and record each as a data artifact (capped at 200 by default; writes a customer_profiles_entity_assignment_lookup record with the coverage of the walk)

Argument	Type	Required	Description
object_type?	string	no	A string to filter the results by (EndUserType or SupportingDocumentType) machine-name. This is useful when you want to retrieve the entity-assignment of a specific end-user or supporting document.
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 customer_profiles_entity_assignment_lookup record reports truncated: true.

fn delete(id: string)

Delete the customer profiles entity assignment

Argument	Type	Required	Description
id	string	yes	The sid of the customer profiles entity assignment

fn sync()

Sync customer profiles entity assignment state from Twilio

Resources

state— Customer profiles entity assignment resource state

customer_profiles_evaluation.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.
customer_profile_sid	string	yes	Path scope for the customer profiles evaluation: customer_profile_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
policy_sid	string	yes	The unique string of a policy that is associated to the customer_profile resource.
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 customer profiles evaluation

fn get(id: string)

Get a customer profiles evaluation

Argument	Type	Required	Description
id	string	yes	The sid of the customer profiles evaluation

fn lookup(max_items?: number)

List customer profiles evaluations and record each as a data artifact (capped at 200 by default; writes a customer_profiles_evaluation_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 customer_profiles_evaluation_lookup record reports truncated: true.

fn sync()

Sync customer profiles evaluation state from Twilio

Resources

state— Customer profiles evaluation resource state

customer_profiles_provisional_copy.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.
customer_profile_sid	string	yes	Path scope for the customer profiles provisional copy: customer_profile_sid
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 customer profiles provisional copy

fn update()

Update customer profiles provisional copy attributes

fn sync()

Sync customer profiles provisional copy state from Twilio

end_user.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	The string that you assigned to describe the resource.
attributes?	string	no	The set of parameters that are the attributes of the End User resource which are derived End User Types.
type	string	yes	The type of end user of the Bundle resource - can be `individual` or `business`.
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 end user

fn get(id: string)

Get a end user

Argument	Type	Required	Description
id	string	yes	The sid of the end user

fn lookup(max_items?: number)

List end users and record each as a data artifact (capped at 200 by default; writes a end_user_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 end_user_lookup record reports truncated: true.

fn update()

Update end user attributes

fn delete(id: string)

Delete the end user

Argument	Type	Required	Description
id	string	yes	The sid of the end user

fn sync()

Sync end user state from Twilio

Resources

state— End user resource state

end_user_type.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 end user type

Argument	Type	Required	Description
id	string	yes	The sid of the end user type

fn lookup(max_items?: number)

List end user types and record each as a data artifact (capped at 200 by default; writes a end_user_type_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 end_user_type_lookup record reports truncated: true.

fn sync()

Sync end user type state from Twilio

Resources

state— End user type resource state

gb_compliance_registration_inquiry.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.
registration_id	string	yes	Path scope for the gb compliance registration inquiry: registration_id
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
is_isv_embed?	boolean	no	Indicates if the inquiry is being started from an ISV embedded component.
theme_set_id?	string	no	Theme id for styling the inquiry form.
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 gb compliance registration inquiry attributes

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

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

fn lookup(max_items?: number)

List policys and record each as a data artifact (capped at 200 by default; writes a policy_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 policy_lookup record reports truncated: true.

fn sync()

Sync policy state from Twilio

Resources

state— Policy resource state

supporting_document.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	The string that you assigned to describe the resource.
attributes?	string	no	The set of parameters that are the attributes of the Supporting Documents resource which are derived Supporting Document Types.
type	string	yes	The type of the Supporting Document.
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 supporting document

fn get(id: string)

Get a supporting document

Argument	Type	Required	Description
id	string	yes	The sid of the supporting document

fn lookup(max_items?: number)

List supporting documents and record each as a data artifact (capped at 200 by default; writes a supporting_document_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 supporting_document_lookup record reports truncated: true.

fn update()

Update supporting document attributes

fn delete(id: string)

Delete the supporting document

Argument	Type	Required	Description
id	string	yes	The sid of the supporting document

fn sync()

Sync supporting document state from Twilio

Resources

state— Supporting document resource state

supporting_document_type.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 supporting document type

Argument	Type	Required	Description
id	string	yes	The sid of the supporting document type

fn lookup(max_items?: number)

List supporting document types and record each as a data artifact (capped at 200 by default; writes a supporting_document_type_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 supporting_document_type_lookup record reports truncated: true.

fn sync()

Sync supporting document type state from Twilio

Resources

state— Supporting document type resource state

trust_product.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)
status?	enum	no	The verification status of the Trust Product resource.
status_callback?	string	no	The URL we call to inform your application of status changes.
friendly_name	string	yes	The string that you assigned to describe the resource.
email	string	yes	The email address that will receive updates when the Trust Product resource changes status.
policy_sid	string	yes	The unique string of a policy that is associated to the Trust Product resource.
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 trust product

fn get(id: string)

Get a trust product

Argument	Type	Required	Description
id	string	yes	The sid of the trust product

fn lookup(status?: enum, friendly_name?: string, policy_sid?: string, max_items?: number)

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

Argument	Type	Required	Description
status?	enum	no	The verification status of the Trust Product resource.
friendly_name?	string	no	The string that you assigned to describe the resource.
policy_sid?	string	no	The unique string of a policy that is associated to the Trust Product resource.
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 trust_product_lookup record reports truncated: true.

fn update()

Update trust product attributes

fn delete(id: string)

Delete the trust product

Argument	Type	Required	Description
id	string	yes	The sid of the trust product

fn sync()

Sync trust product state from Twilio

Resources

state— Trust product resource state

trust_products_channel_endpoint_assignment.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.
trust_product_sid	string	yes	Path scope for the trust products channel endpoint assignment: trust_product_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
channel_endpoint_type	string	yes	The type of channel endpoint. eg: phone-number
channel_endpoint_sid	string	yes	The SID of an channel endpoint
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 trust products channel endpoint assignment

fn get(id: string)

Get a trust products channel endpoint assignment

Argument	Type	Required	Description
id	string	yes	The sid of the trust products channel endpoint assignment

fn lookup(channel_endpoint_sid?: string, channel_endpoint_sids?: string, max_items?: number)

List trust products channel endpoint assignments and record each as a data artifact (capped at 200 by default; writes a trust_products_channel_endpoint_assignment_lookup record with the coverage of the walk)

Argument	Type	Required	Description
channel_endpoint_sid?	string	no	The SID of an channel endpoint
channel_endpoint_sids?	string	no	comma separated list of channel endpoint sids
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 trust_products_channel_endpoint_assignment_lookup record reports truncated: true.

fn delete(id: string)

Delete the trust products channel endpoint assignment

Argument	Type	Required	Description
id	string	yes	The sid of the trust products channel endpoint assignment

fn sync()

Sync trust products channel endpoint assignment state from Twilio

Resources

state— Trust products channel endpoint assignment resource state

trust_products_entity_assignment.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.
trust_product_sid	string	yes	Path scope for the trust products entity assignment: trust_product_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
object_sid	string	yes	The SID of an object bag that holds information of the different items.
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 trust products entity assignment

fn get(id: string)

Get a trust products entity assignment

Argument	Type	Required	Description
id	string	yes	The sid of the trust products entity assignment

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

List trust products entity assignments and record each as a data artifact (capped at 200 by default; writes a trust_products_entity_assignment_lookup record with the coverage of the walk)

Argument	Type	Required	Description
object_type?	string	no	A string to filter the results by (EndUserType or SupportingDocumentType) machine-name. This is useful when you want to retrieve the entity-assignment of a specific end-user or supporting document.
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 trust_products_entity_assignment_lookup record reports truncated: true.

fn delete(id: string)

Delete the trust products entity assignment

Argument	Type	Required	Description
id	string	yes	The sid of the trust products entity assignment

fn sync()

Sync trust products entity assignment state from Twilio

Resources

state— Trust products entity assignment resource state

trust_products_evaluation.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.
trust_product_sid	string	yes	Path scope for the trust products evaluation: trust_product_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
policy_sid	string	yes	The unique string of a policy that is associated to the customer_profile resource.
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 trust products evaluation

fn get(id: string)

Get a trust products evaluation

Argument	Type	Required	Description
id	string	yes	The sid of the trust products evaluation

fn lookup(max_items?: number)

List trust products evaluations and record each as a data artifact (capped at 200 by default; writes a trust_products_evaluation_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 trust_products_evaluation_lookup record reports truncated: true.

fn sync()

Sync trust products evaluation state from Twilio

Resources

state— Trust products evaluation resource state

trust_products_provisional_copy.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.
trust_product_sid	string	yes	Path scope for the trust products provisional copy: trust_product_sid
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 trust products provisional copy

fn update()

Update trust products provisional copy attributes

fn sync()

Sync trust products provisional copy state from Twilio

04Stats

85 / 100

Downloads

Archive size

88.8 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 #trusthub #communications #saas