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
Account sid auth token

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

application/x-www-form-urlencoded

Body

  • TollfreePhoneNumber string(phone-number) Required

    The Tollfree phone number to be verified

  • NotificationEmail string Required

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

  • BusinessName string

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

  • BusinessWebsite string

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

  • UseCaseCategories array[string]

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

  • UseCaseSummary string

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

  • ProductionMessageSample string

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

  • OptInImageUrls array[string]

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

  • OptInType string

    Values are VERBAL, WEB_FORM, PAPER_FORM, VIA_TEXT, or MOBILE_QR_CODE.

  • MessageVolume string

    Estimate monthly volume of messages from the Tollfree Number.

  • BusinessStreetAddress string

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

  • BusinessStreetAddress2 string

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

  • BusinessCity string

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

  • BusinessStateProvinceRegion string

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

  • BusinessPostalCode string

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

  • BusinessCountry string

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

  • AdditionalInformation string

    Additional information to be provided for verification.

  • BusinessContactFirstName string

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

  • BusinessContactLastName string

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

  • BusinessContactEmail string

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

  • BusinessContactPhone string(phone-number)

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

  • ThemeSetId string

    Theme id for styling the inquiry form.

  • SkipMessagingUseCase boolean

    Skip the messaging use case screen of the inquiry form.

Responses

  • 201 application/json

    Created

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • inquiry_id string | null

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

    • inquiry_session_token string | null

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

    • registration_id string | null

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

    • url string(uri) | null

      The URL of this resource.
POST /v1/ComplianceInquiries/Tollfree/Initialize 
curl \
 --request POST 'https://trusthub.twilio.com/v1/ComplianceInquiries/Tollfree/Initialize' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'NotificationEmail=jeff%40twilio.com&TollfreePhoneNumber=%2B123445566'
Request examples 
{"NotificationEmail"=>"jeff@twilio.com", "TollfreePhoneNumber"=>"+123445566"}
{"OptInType"=>"VERBAL", "ThemeSetId"=>"theme_set_id", "BusinessCity"=>"Anytown", "BusinessName"=>"Owl, Inc.", "MessageVolume"=>"10", "OptInImageUrls"=>["https://testbusiness.com/images/image1.jpg", "https://testbusiness.com/images/image2.jpg"], "UseCaseSummary"=>"This number is used to send out promotional offers and coupons to the customers of John's Coffee Shop", "BusinessCountry"=>"US", "BusinessWebsite"=>"http://www.company.com", "NotificationEmail"=>"jeff@twilio.com", "UseCaseCategories"=>["TWO_FACTOR_AUTHENTICATION", "MARKETING"], "BusinessPostalCode"=>"11111", "TollfreePhoneNumber"=>"+123445566", "BusinessContactEmail"=>"email@company.com", "BusinessContactPhone"=>"+1231231234", "SkipMessagingUseCase"=>true, "AdditionalInformation"=>"see our privacy policy here www.johnscoffeeshop.com/privacypolicy", "BusinessStreetAddress"=>"123 Main Street", "BusinessStreetAddress2"=>"Suite 101", "BusinessContactLastName"=>"lastname", "ProductionMessageSample"=>"lorem ipsum", "BusinessContactFirstName"=>"firstname", "BusinessStateProvinceRegion"=>"AA"}
Response examples (201) 
{
  "url": "https://trusthub.twilio.com/v1/ComplianceInquiries/Tollfree/Initialize",
  "inquiry_id": "inq_aaaaaaaaaaaaaaaaaaaaaaaa",
  "registration_id": "tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.tollfree.PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "inquiry_session_token": "new.session.token"
}
{
  "url": "https://trusthub.twilio.com/v1/ComplianceInquiries/Tollfree/Initialize",
  "inquiry_id": "inq_aaaaaaaaaaaaaaaaaaaaaaaa",
  "registration_id": "tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.tollfree.PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "inquiry_session_token": "new.session.token"
}