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

POST /v1/ComplianceInquiries/Registration/RegulatoryCompliance/GB/Initialize
Account sid auth token

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

application/x-www-form-urlencoded

Body

  • EndUserType string Required

    Values are Individual or Business.

  • PhoneNumberType string Required

    Values are local, national, mobile, or toll-free.

  • BusinessIdentityType string

    Values are direct_customer, isv_reseller_or_partner, or unknown.

  • BusinessRegistrationAuthority string

    Values are UK:CRN, US:EIN, CA:CBN, AU:ACN, or Other.

  • BusinessLegalName string

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

  • NotificationEmail string

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

  • AcceptedNotificationReceipt boolean

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

  • BusinessRegistrationNumber string

    Business registration number of the business

  • BusinessWebsiteUrl string

    The URL of the business website

  • FriendlyName string

    Friendly name for your business information

  • AuthorizedRepresentative1FirstName string

    First name of the authorized representative

  • AuthorizedRepresentative1LastName string

    Last name of the authorized representative

  • AuthorizedRepresentative1Phone string

    Phone number of the authorized representative

  • AuthorizedRepresentative1Email string

    Email address of the authorized representative

  • AuthorizedRepresentative1DateOfBirth string

    Birthdate of the authorized representative

  • AddressStreet string

    Street address of the business

  • AddressStreetSecondary string

    Street address of the business

  • AddressCity string

    City of the business

  • AddressSubdivision string

    State or province of the business

  • AddressPostalCode string

    Postal code of the business

  • AddressCountryCode string

    Country code of the business

  • EmergencyAddressStreet string

    Street address of the business

  • EmergencyAddressStreetSecondary string

    Street address of the business

  • EmergencyAddressCity string

    City of the business

  • EmergencyAddressSubdivision string

    State or province of the business

  • EmergencyAddressPostalCode string

    Postal code of the business

  • EmergencyAddressCountryCode string

    Country code of the business

  • UseAddressAsEmergencyAddress boolean

    Use the business address as the emergency address

  • FileName string

    The name of the verification document to upload

  • File string

    The verification document to upload

  • FirstName string

    The first name of the Individual User.

  • LastName string

    The last name of the Individual User.

  • DateOfBirth string

    The date of birth of the Individual User.

  • IndividualEmail string

    The email address of the Individual User.

  • IndividualPhone string

    The phone number of the Individual User.

  • IsIsvEmbed boolean

    Indicates if the inquiry is being started from an ISV embedded component.

  • IsvRegisteringForSelfOrTenant string

    Indicates if the isv registering for self or tenant.

  • StatusCallbackUrl string

    The url we call to inform you of bundle changes.

  • ThemeSetId string

    Theme id for styling 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 RegistrationId matching the Registration Profile that should be resumed or resubmitted for editing.

    • url string(uri) | null

      The URL of this resource.
POST /v1/ComplianceInquiries/Registration/RegulatoryCompliance/GB/Initialize 
curl \
 --request POST 'https://trusthub.twilio.com/v1/ComplianceInquiries/Registration/RegulatoryCompliance/GB/Initialize' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'File=file&FileName=fileName&LastName=lastname&FirstName=firstname&IsIsvEmbed=true&ThemeSetId=th_xxxxx&AddressCity=San+Francisco&DateOfBirth=1990-01-01&EndUserType=Individual&FriendlyName=Owl&AddressStreet=123+Main+St&IndividualEmail=test%40test.com&IndividualPhone=123456&PhoneNumberType=national&AddressPostalCode=94107&BusinessLegalName=Owl%2C+Inc.&NotificationEmail=test%40test.com&StatusCallbackUrl=https%3A%2F%2Fstatus.com&AddressCountryCode=US&AddressSubdivision=CA&BusinessWebsiteUrl=https%3A%2F%2Ftwilio.co&BusinessIdentityType=direct_customer&EmergencyAddressCity=San+Francisco&AddressStreetSecondary=Apt+1&EmergencyAddressStreet=123+Main+St&BusinessRegistrationNumber=123456789&EmergencyAddressPostalCode=94107&AcceptedNotificationReceipt=true&EmergencyAddressCountryCode=US&EmergencyAddressSubdivision=CA&UseAddressAsEmergencyAddress=true&BusinessRegistrationAuthority=UK%3ACRN&IsvRegisteringForSelfOrTenant=my_customer&AuthorizedRepresentative1Email=test%40test.com&AuthorizedRepresentative1Phone=%2B9199992222222&EmergencyAddressStreetSecondary=Apt+1&AuthorizedRepresentative1LastName=lastname&AuthorizedRepresentative1FirstName=firstname&AuthorizedRepresentative1DateOfBirth=1990-01-01'
Request example 
{"File" => "file", "FileName" => "fileName", "LastName" => "lastname", "FirstName" => "firstname", "IsIsvEmbed" => true, "ThemeSetId" => "th_xxxxx", "AddressCity" => "San Francisco", "DateOfBirth" => "1990-01-01", "EndUserType" => "Individual", "FriendlyName" => "Owl", "AddressStreet" => "123 Main St", "IndividualEmail" => "test@test.com", "IndividualPhone" => "123456", "PhoneNumberType" => "national", "AddressPostalCode" => "94107", "BusinessLegalName" => "Owl, Inc.", "NotificationEmail" => "test@test.com", "StatusCallbackUrl" => "https://status.com", "AddressCountryCode" => "US", "AddressSubdivision" => "CA", "BusinessWebsiteUrl" => "https://twilio.co", "BusinessIdentityType" => "direct_customer", "EmergencyAddressCity" => "San Francisco", "AddressStreetSecondary" => "Apt 1", "EmergencyAddressStreet" => "123 Main St", "BusinessRegistrationNumber" => "123456789", "EmergencyAddressPostalCode" => "94107", "AcceptedNotificationReceipt" => true, "EmergencyAddressCountryCode" => "US", "EmergencyAddressSubdivision" => "CA", "UseAddressAsEmergencyAddress" => true, "BusinessRegistrationAuthority" => "UK:CRN", "IsvRegisteringForSelfOrTenant" => "my_customer", "AuthorizedRepresentative1Email" => "test@test.com", "AuthorizedRepresentative1Phone" => "+9199992222222", "EmergencyAddressStreetSecondary" => "Apt 1", "AuthorizedRepresentative1LastName" => "lastname", "AuthorizedRepresentative1FirstName" => "firstname", "AuthorizedRepresentative1DateOfBirth" => "1990-01-01"}
Response examples (201) 
{
  "url": "https://trusthub.twilio.com/v1/ComplianceInquiries/Registration/tri1.us1.account.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.registartion.PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RegulatoryCompliance/GB/Initialize",
  "inquiry_id": "inq_aaaaaaaaaaaaaaaaaaaaaaaa",
  "registration_id": "tri1.us1.account.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.registartion.PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "inquiry_session_token": "new.session.token"
}