Sign in
MessagingV1TollfreeVerification

Retrieve a tollfree verification

Retrieve a tollfree verification

get/v1/Tollfree/Verifications/{Sid}

Path parameters

Sidstring required

A unique string identifying a Tollfree Verification.

Response

OK

sidstring nullable

The unique string to identify Tollfree Verification.

account_sidstring nullable

The SID of the Account that created the Tollfree Verification resource.

customer_profile_sidstring nullable

Customer's Profile Bundle BundleSid.

trust_product_sidstring nullable

Tollfree TrustProduct Bundle BundleSid.

date_createdstring date-time nullable

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_updatedstring date-time nullable

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

regulated_item_sidstring nullable

The SID of the Regulated Item.

business_namestring nullable

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

business_street_addressstring nullable

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

business_street_address2string nullable

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

business_citystring nullable

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

business_state_province_regionstring nullable

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

business_postal_codestring nullable

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

business_countrystring nullable

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

business_websitestring nullable

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

business_contact_first_namestring nullable

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

business_contact_last_namestring nullable

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

business_contact_emailstring nullable

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

business_contact_phonestring phone-number nullable

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

notification_emailstring nullable

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

use_case_categoriesstring[] nullable

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

use_case_summarystring nullable

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

production_message_samplestring nullable

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

opt_in_image_urlsstring[] nullable

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

opt_in_type'VERBAL' | 'WEB_FORM' | 'PAPER_FORM' | 'VIA_TEXT' | 'MOBILE_QR_CODE' | 'IMPORT' | 'IMPORT_PLEASE_REPLACE'

Describe how a user opts-in to text messages.

message_volumestring nullable

Estimate monthly volume of messages from the Tollfree Number.

additional_informationstring nullable

Additional information to be provided for verification.

tollfree_phone_number_sidstring nullable

The SID of the Phone Number associated with the Tollfree Verification.

tollfree_phone_numberstring phone-number nullable

The E.164 formatted toll-free phone number associated with the verification.

status'PENDING_REVIEW' | 'IN_REVIEW' | 'TWILIO_APPROVED' | 'TWILIO_REJECTED'

The compliance status of the Tollfree Verification record.

urlstring uri nullable

The absolute URL of the Tollfree Verification resource.

rejection_reasonstring nullable

The rejection reason given when a Tollfree Verification has been rejected.

error_codeinteger nullable

The error code given when a Tollfree Verification has been rejected.

edit_expirationstring date-time nullable

The date and time when the ability to edit a rejected verification expires.

edit_allowedboolean nullable

If a rejected verification is allowed to be edited/resubmitted. Some rejection reasons allow editing and some do not.

business_registration_numberstring nullable

A legally recognized business registration number

business_registration_authority'EIN' | 'CBN' | 'CRN' | 'PROVINCIAL_NUMBER' | 'VAT' | 'ACN' | 'ABN' | 'BRN' | 'SIREN' | 'SIRET' | 'NZBN' | 'USt-IdNr' | 'CIF' | 'NIF' | 'CNPJ' | 'UID' | 'NEQ' | 'OTHER' nullable

The organizational authority for business registrations. Required for all business types except SOLE_PROPRIETOR.

business_registration_countrystring nullable

Country business is registered in

business_type'PRIVATE_PROFIT' | 'PUBLIC_PROFIT' | 'SOLE_PROPRIETOR' | 'NON_PROFIT' | 'GOVERNMENT' nullable

The type of business, valid values are PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, SOLE_PROPRIETOR, GOVERNMENT. Required field.

business_registration_phone_numberstring nullable

The E.164 formatted number associated with the business.

doing_business_asstring nullable

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

opt_in_confirmation_messagestring nullable

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

help_message_samplestring nullable

A sample help message provided to users.

privacy_policy_urlstring uri nullable

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

terms_and_conditions_urlstring uri nullable

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

age_gated_contentboolean nullable

Indicates if the content is age gated.

opt_in_keywordsstring[] nullable

List of keywords that users can send to opt in or out of messages.

{"stackTrail":"components:schemas:messaging.v1.tollfree_verification:properties:resource_links","oasType":"schema","type":"unknown","description":"The URLs of the documents associated with the Tollfree Verification resource.","nullable":true}
external_reference_idstring nullable

An optional external reference ID supplied by customer and echoed back on status retrieval.

vetting_idstring nullable
vetting_provider'CAMPAIGN_VERIFY' nullable

The third-party political vetting provider.

vetting_id_expirationstring date-time nullable

Changes

Changed in 13 of the 103 revisions of this API.43521

  • v1ef8fb6b6bfee32See the full diff
    • ●

      added the new ABN enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new ACCOUNT_NOTIFICATIONS enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new ACN enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new BRN enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new CBN enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new CHARITY_NONPROFIT enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new CIF enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new CNPJ enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new CRN enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new CUSTOMER_CARE enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new DELIVERY_NOTIFICATIONS enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new EIN enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new EVENTS enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new FRAUD_ALERT_MESSAGING enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new HIGHER_EDUCATION enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new K12 enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new MARKETING enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new NEQ enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new NIF enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new NZBN enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new OTHER enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new POLITICAL_ELECTION_CAMPAIGNS enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new POLLING_AND_VOTING_NON_POLITICAL enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new PROVINCIAL_NUMBER enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PUBLIC_SERVICE_ANNOUNCEMENT enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new SECURITY_ALERT enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new SIREN enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new SIRET enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new TWO_FACTOR_AUTHENTICATION enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new UID enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new USt-IdNr enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new VAT enum value to the response property for the response status

      response-property-enum-value-added

  • v184b2771d2bba3See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • v1dfa6304799eb13See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • v11001b3de98851See the full diff
    • ▲

      the response's property type changed from object to no type for status

      response-property-type-changed

  • v159b0953d2c631See the full diff
    • ▲

      the / response's property type changed from object to no type for status

      response-property-type-changed

  • v167b38e582c6821See the full diff
    • ▲

      the / response's property type changed from no type to object for status

      response-property-type-changed

    • ▲

      the response's property type changed from no type to object for status

      response-property-type-changed

    • ●

      added the new IMPORT_PLEASE_REPLACE enum value to the response property for the response status

      response-property-enum-value-added

  • v1b31951a640151See the full diff
    • ●

      added the new IMPORT enum value to the response property for the response status

      response-property-enum-value-added

  • v1968e4aa698231See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • v1a41ed9727dd61See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • v1c4b8c1c6b5921See the full diff
    • ●

      removed the optional property from the response with the status

      response-optional-property-removed