TWtwilio
TrusthubV1ComplianceTollfreeInquiries

Create a new Compliance Tollfree Verification Inquiry for the authenticated account. This is necessary to start a new embedded session.

Changed on

Create a new Compliance Tollfree Verification Inquiry for the authenticated account. This is necessary to start a new embedded session.

post/v1/ComplianceInquiries/Tollfree/Initialize

Request

  • Base URL
    https://trusthub.twilio.com
  • URL
    https://trusthub.twilio.com/v1/ComplianceInquiries/Tollfree/Initialize
  • Auth
    HTTP basic

Request body application/x-www-form-urlencoded

TollfreePhoneNumberstring phone-number required

The Tollfree phone number to be verified

NotificationEmailstring required

The email address to receive the notification about the verification result.

CustomerProfileSidstring

The Customer Profile Sid associated with the Account.

BusinessNamestring

The name of the business or organization using the Tollfree number.

BusinessWebsitestring

The website of the business or organization using the Tollfree number.

UseCaseCategoriesstring[]

The category of the use case for the Tollfree Number. List as many are applicable..

UseCaseSummarystring

Use this to further explain how messaging is used by the business or organization.

ProductionMessageSamplestring

An example of message content, i.e. a sample message.

OptInImageUrlsstring[]

Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL.

OptInType'VERBAL' | 'WEB_FORM' | 'PAPER_FORM' | 'VIA_TEXT' | 'MOBILE_QR_CODE'

Describe how a user opts-in to text messages.

MessageVolumestring

Estimate monthly volume of messages from the Tollfree Number.

BusinessStreetAddressstring

The address of the business or organization using the Tollfree number.

BusinessStreetAddress2string

The address of the business or organization using the Tollfree number.

BusinessCitystring

The city of the business or organization using the Tollfree number.

BusinessStateProvinceRegionstring

The state/province/region of the business or organization using the Tollfree number.

BusinessPostalCodestring

The postal code of the business or organization using the Tollfree number.

BusinessCountrystring

The country of the business or organization using the Tollfree number.

AdditionalInformationstring

Additional information to be provided for verification.

BusinessContactFirstNamestring

The first name of the contact for the business or organization using the Tollfree number.

BusinessContactLastNamestring

The last name of the contact for the business or organization using the Tollfree number.

BusinessContactEmailstring

The email address of the contact for the business or organization using the Tollfree number.

BusinessContactPhonestring phone-number

The phone number of the contact for the business or organization using the Tollfree number.

ThemeSetIdstring

Theme id for styling the inquiry form.

SkipMessagingUseCaseboolean

Skip the messaging use case screen of the inquiry form.

BusinessRegistrationNumberstring

The Business Registration Number of the business or organization.

BusinessRegistrationAuthoritystring

The Business Registration Authority of the business or organization.

BusinessRegistrationCountrystring

The Business Registration Country of the business or organization.

BusinessType'PRIVATE_PROFIT' | 'PUBLIC_PROFIT' | 'NON_PROFIT' | 'SOLE_PROPRIETOR' | 'GOVERNMENT'

Type of Business.

DoingBusinessAsstring

Trade name, sub entity, or downstream business name of business being submitted for verification.

OptInConfirmationMessagestring

The confirmation message sent to users when they opt in to receive messages.

HelpMessageSamplestring

A sample help message provided to users.

PrivacyPolicyUrlstring

The URL to the privacy policy for the business or organization.

TermsAndConditionsUrlstring

The URL to the terms and conditions for the business or organization.

AgeGatedContentboolean

Indicates if the content is age gated.

ExternalReferenceIdstring

A legally recognized business registration number.

OptInKeywordsstring[]

List of keywords that users can text in to opt in to receive messages.

VettingIdstring

Unique identifier for the created Vetting .

VettingProviderstring

Name of the vetting provider.

Response

Created

inquiry_idstring nullable

The unique ID used to start an embedded compliance registration session.

inquiry_session_tokenstring nullable

The session token used to start an embedded compliance registration session.

registration_idstring nullable

The TolfreeId matching the Tollfree Profile that should be resumed or resubmitted for editing.

urlstring uri nullable

The URL of this resource.

Changes

  • v14a9e402f6fc7Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

  • v16211bab972caRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property