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

POST /v1/ComplianceInquiries/Customers/Initialize
Account sid auth token

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

application/x-www-form-urlencoded

Body

  • PrimaryProfileSid string Required

    The unique SID identifier of the Primary Customer Profile that should be used as a parent. Only necessary when creating a secondary Customer Profile.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^BU[0-9a-fA-F]{32}$.

  • NotificationEmail string

    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.

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

    • customer_id string | null

      The CustomerID matching the Customer Profile that should be resumed or resubmitted for editing.

    • url string(uri) | null

      The URL of this resource.
POST /v1/ComplianceInquiries/Customers/Initialize 
curl \
 --request POST 'https://trusthub.twilio.com/v1/ComplianceInquiries/Customers/Initialize' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'PrimaryProfileSid=BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'
Request examples 
{"PrimaryProfileSid"=>"BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}
{"NotificationEmail"=>"pfarnsworth@twilio.com", "PrimaryProfileSid"=>"BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}
{"ThemeSetId"=>"th_xxxxx", "NotificationEmail"=>"pfarnsworth@twilio.com", "PrimaryProfileSid"=>"BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}
Response examples (201) 
{
  "url": "https://trusthub.twilio.com/v1/ComplianceInquiries/Customers/tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Initialize",
  "inquiry_id": "inq_aaaaaaaaaaaaaaaaaaaaaaaa",
  "customer_id": "tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "inquiry_session_token": "new.session.token"
}
{
  "url": "https://trusthub.twilio.com/v1/ComplianceInquiries/Customers/tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Initialize",
  "inquiry_id": "inq_aaaaaaaaaaaaaaaaaaaaaaaa",
  "customer_id": "tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "inquiry_session_token": "new.session.token"
}
{
  "url": "https://trusthub.twilio.com/v1/ComplianceInquiries/Customers/tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Initialize",
  "inquiry_id": "inq_aaaaaaaaaaaaaaaaaaaaaaaa",
  "customer_id": "tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "inquiry_session_token": "new.session.token"
}