Twilio Trust Hub API

components:
  schemas:
    trusthub.v1.compliance_inquiry:
      type: object
      properties:
        inquiry_id:
          type: string
          nullable: true
          description: >-
            The unique ID used to start an embedded compliance registration
            session.
        inquiry_session_token:
          type: string
          nullable: true
          description: >-
            The session token used to start an embedded compliance registration
            session.
        customer_id:
          type: string
          nullable: true
          description: >-
            The CustomerID matching the Customer Profile that should be resumed
            or resubmitted for editing.
        url:
          type: string
          format: uri
          nullable: true
          description: The URL of this resource.
    trusthub.v1.compliance_tollfree_inquiry:
      type: object
      properties:
        inquiry_id:
          type: string
          nullable: true
          description: >-
            The unique ID used to start an embedded compliance registration
            session.
        inquiry_session_token:
          type: string
          nullable: true
          description: >-
            The session token used to start an embedded compliance registration
            session.
        registration_id:
          type: string
          nullable: true
          description: >-
            The TolfreeId matching the Tollfree Profile that should be resumed
            or resubmitted for editing.
        url:
          type: string
          format: uri
          nullable: true
          description: The URL of this resource.
    compliance_tollfree_inquiry_enum_status:
      type: string
      enum:
        - PENDING_REVIEW
        - IN_REVIEW
        - TWILIO_APPROVED
        - TWILIO_REJECTED
    compliance_tollfree_inquiry_enum_opt_in_type:
      type: string
      enum:
        - VERBAL
        - WEB_FORM
        - PAPER_FORM
        - VIA_TEXT
        - MOBILE_QR_CODE
    trusthub.v1.customer_profile:
      type: object
      properties:
        sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^BU[0-9a-fA-F]{32}$
          nullable: true
          description: >-
            The unique string that we created to identify the Customer-Profile
            resource.
        account_sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^AC[0-9a-fA-F]{32}$
          nullable: true
          description: >-
            The SID of the
            [Account](https://www.twilio.com/docs/iam/api/account) that created
            the Customer-Profile resource.
        policy_sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^RN[0-9a-fA-F]{32}$
          nullable: true
          description: >-
            The unique string of a policy that is associated to the
            Customer-Profile resource.
        friendly_name:
          type: string
          nullable: true
          description: The string that you assigned to describe the resource.
        status:
          type: string
          $ref: '#/components/schemas/customer_profile_enum_status'
          nullable: true
          description: The verification status of the Customer-Profile resource.
        valid_until:
          type: string
          format: date-time
          nullable: true
          description: >-
            The date and time in GMT in [ISO
            8601](https://en.wikipedia.org/wiki/ISO_8601) format when the
            resource will be valid until.
        email:
          type: string
          nullable: true
          description: >-
            The email address that will receive updates when the
            Customer-Profile resource changes status.
        status_callback:
          type: string
          format: uri
          nullable: true
          description: The URL we call to inform your application of status changes.
        date_created:
          type: string
          format: date-time
          nullable: true
          description: >-
            The date and time in GMT when the resource was created specified in
            [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
        date_updated:
          type: string
          format: date-time
          nullable: true
          description: >-
            The date and time in GMT when the resource was last updated
            specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
            format.
        url:
          type: string
          format: uri
          nullable: true
          description: The absolute URL of the Customer-Profile resource.
        links:
          type: object
          format: uri-map
          nullable: true
          description: The URLs of the Assigned Items of the Customer-Profile resource.
    customer_profile_enum_status:
      type: string
      enum:
        - draft
        - pending-review
        - in-review
        - twilio-rejected
        - twilio-approved
    customer_profile_enum_end_user_type:
      type: string
      enum:
        - individual
        - business
    trusthub.v1.customer_profile.customer_profile_channel_endpoint_assignment:
      type: object
      properties:
        sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^RA[0-9a-fA-F]{32}$
          nullable: true
          description: >-
            The unique string that we created to identify the Item Assignment
            resource.
        customer_profile_sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^BU[0-9a-fA-F]{32}$
          nullable: true
          description: >-
            The unique string that we created to identify the CustomerProfile
            resource.
        account_sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^AC[0-9a-fA-F]{32}$
          nullable: true
          description: >-
            The SID of the
            [Account](https://www.twilio.com/docs/iam/api/account) that created
            the Item Assignment resource.
        channel_endpoint_type:
          type: string
          nullable: true
          description: 'The type of channel endpoint. eg: phone-number'
        channel_endpoint_sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$
          nullable: true
          description: The SID of an channel endpoint
        date_created:
          type: string
          format: date-time
          nullable: true
          description: >-
            The date and time in GMT when the resource was created specified in
            [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
        url:
          type: string
          format: uri
          nullable: true
          description: The absolute URL of the Identity resource.
    trusthub.v1.customer_profile.customer_profile_entity_assignment:
      type: object
      properties:
        sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^BV[0-9a-fA-F]{32}$
          nullable: true
          description: >-
            The unique string that we created to identify the Item Assignment
            resource.
        customer_profile_sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^BU[0-9a-fA-F]{32}$
          nullable: true
          description: >-
            The unique string that we created to identify the CustomerProfile
            resource.
        account_sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^AC[0-9a-fA-F]{32}$
          nullable: true
          description: >-
            The SID of the
            [Account](https://www.twilio.com/docs/iam/api/account) that created
            the Item Assignment resource.
        object_sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$
          nullable: true
          description: >-
            The SID of an object bag that holds information of the different
            items.
        date_created:
          type: string
          format: date-time
          nullable: true
          description: >-
            The date and time in GMT when the resource was created specified in
            [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
        url:
          type: string
          format: uri
          nullable: true
          description: The absolute URL of the Identity resource.
    trusthub.v1.customer_profile.customer_profile_evaluation:
      type: object
      properties:
        sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^EL[0-9a-fA-F]{32}$
          nullable: true
          description: The unique string that identifies the Evaluation resource.
        account_sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^AC[0-9a-fA-F]{32}$
          nullable: true
          description: >-
            The SID of the
            [Account](https://www.twilio.com/docs/iam/api/account) that created
            the customer_profile resource.
        policy_sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^RN[0-9a-fA-F]{32}$
          nullable: true
          description: >-
            The unique string of a policy that is associated to the
            customer_profile resource.
        customer_profile_sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^BU[0-9a-fA-F]{32}$
          nullable: true
          description: >-
            The unique string that we created to identify the customer_profile
            resource.
        status:
          type: string
          $ref: '#/components/schemas/customer_profile_evaluation_enum_status'
          nullable: true
          description: The compliance status of the Evaluation resource.
        results:
          type: array
          items: {}
          nullable: true
          description: >-
            The results of the Evaluation which includes the valid and invalid
            attributes.
        date_created:
          type: string
          format: date-time
          nullable: true
        url:
          type: string
          format: uri
          nullable: true
    customer_profile_evaluation_enum_status:
      type: string
      enum:
        - compliant
        - noncompliant
    trusthub.v1.end_user:
      type: object
      properties:
        sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^IT[0-9a-fA-F]{32}$
          nullable: true
          description: >-
            The unique string created by Twilio to identify the End User
            resource.
        account_sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^AC[0-9a-fA-F]{32}$
          nullable: true
          description: >-
            The SID of the
            [Account](https://www.twilio.com/docs/iam/api/account) that created
            the End User resource.
        friendly_name:
          type: string
          nullable: true
          description: The string that you assigned to describe the resource.
        type:
          type: string
          nullable: true
          description: >-
            The type of end user of the Bundle resource - can be `individual` or
            `business`.
        attributes:
          nullable: true
          description: >-
            The set of parameters that are the attributes of the End Users
            resource which are listed in the End User Types.
          x-twilio:
            pii:
              handling: standard
              deleteSla: 30
        date_created:
          type: string
          format: date-time
          nullable: true
          description: >-
            The date and time in GMT when the resource was created specified in
            [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
        date_updated:
          type: string
          format: date-time
          nullable: true
          description: >-
            The date and time in GMT when the resource was last updated
            specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
            format.
        url:
          type: string
          format: uri
          nullable: true
          description: The absolute URL of the End User resource.
    trusthub.v1.end_user_type:
      type: object
      properties:
        sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^OY[0-9a-fA-F]{32}$
          nullable: true
          description: The unique string that identifies the End-User Type resource.
        friendly_name:
          type: string
          nullable: true
          description: >-
            A human-readable description that is assigned to describe the
            End-User Type resource. Examples can include first name, last name,
            email, business name, etc
        machine_name:
          type: string
          nullable: true
          description: >-
            A machine-readable description of the End-User Type resource.
            Examples can include first_name, last_name, email, business_name,
            etc.
        fields:
          type: array
          items: {}
          nullable: true
          description: >-
            The required information for creating an End-User. The required
            fields will change as regulatory needs change and will differ for
            businesses and individuals.
        url:
          type: string
          format: uri
          nullable: true
          description: The absolute URL of the End-User Type resource.
    trusthub.v1.policies:
      type: object
      properties:
        sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^RN[0-9a-fA-F]{32}$
          nullable: true
          description: The unique string that identifies the Policy resource.
        friendly_name:
          type: string
          nullable: true
          description: >-
            A human-readable description that is assigned to describe the Policy
            resource. Examples can include Primary Customer profile policy
        requirements:
          nullable: true
          description: The SID of an object that holds the policy information
        url:
          type: string
          format: uri
          nullable: true
          description: The absolute URL of the Policy resource.
    policies_enum_end_user_type:
      type: string
      enum:
        - individual
        - business
    trusthub.v1.supporting_document:
      type: object
      properties:
        sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^RD[0-9a-fA-F]{32}$
          nullable: true
          description: >-
            The unique string created by Twilio to identify the Supporting
            Document resource.
        account_sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^AC[0-9a-fA-F]{32}$
          nullable: true
          description: >-
            The SID of the
            [Account](https://www.twilio.com/docs/iam/api/account) that created
            the Document resource.
        friendly_name:
          type: string
          nullable: true
          description: The string that you assigned to describe the resource.
        mime_type:
          type: string
          nullable: true
          description: The image type uploaded in the Supporting Document container.
        status:
          type: string
          $ref: '#/components/schemas/supporting_document_enum_status'
          nullable: true
          description: The verification status of the Supporting Document resource.
        type:
          type: string
          nullable: true
          description: The type of the Supporting Document.
        attributes:
          nullable: true
          description: >-
            The set of parameters that are the attributes of the Supporting
            Documents resource which are listed in the Supporting Document
            Types.
          x-twilio:
            pii:
              handling: standard
              deleteSla: 30
        date_created:
          type: string
          format: date-time
          nullable: true
          description: >-
            The date and time in GMT when the resource was created specified in
            [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
        date_updated:
          type: string
          format: date-time
          nullable: true
          description: >-
            The date and time in GMT when the resource was last updated
            specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
            format.
        url:
          type: string
          format: uri
          nullable: true
          description: The absolute URL of the Supporting Document resource.
    supporting_document_enum_status:
      type: string
      enum:
        - draft
        - pending-review
        - rejected
        - approved
        - expired
        - provisionally-approved
    trusthub.v1.supporting_document_type:
      type: object
      properties:
        sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^OY[0-9a-fA-F]{32}$
          nullable: true
          description: >-
            The unique string that identifies the Supporting Document Type
            resource.
        friendly_name:
          type: string
          nullable: true
          description: >-
            A human-readable description of the Supporting Document Type
            resource.
        machine_name:
          type: string
          nullable: true
          description: >-
            The machine-readable description of the Supporting Document Type
            resource.
        fields:
          type: array
          items: {}
          nullable: true
          description: >-
            The required information for creating a Supporting Document. The
            required fields will change as regulatory needs change and will
            differ for businesses and individuals.
        url:
          type: string
          format: uri
          nullable: true
          description: The absolute URL of the Supporting Document Type resource.
    trusthub.v1.trust_product:
      type: object
      properties:
        sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^BU[0-9a-fA-F]{32}$
          nullable: true
          description: >-
            The unique string that we created to identify the Customer-Profile
            resource.
        account_sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^AC[0-9a-fA-F]{32}$
          nullable: true
          description: >-
            The SID of the
            [Account](https://www.twilio.com/docs/iam/api/account) that created
            the Customer-Profile resource.
        policy_sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^RN[0-9a-fA-F]{32}$
          nullable: true
          description: >-
            The unique string of a policy that is associated to the
            Customer-Profile resource.
        friendly_name:
          type: string
          nullable: true
          description: The string that you assigned to describe the resource.
        status:
          type: string
          $ref: '#/components/schemas/trust_product_enum_status'
          nullable: true
          description: The verification status of the Customer-Profile resource.
        valid_until:
          type: string
          format: date-time
          nullable: true
          description: >-
            The date and time in GMT in [ISO
            8601](https://en.wikipedia.org/wiki/ISO_8601) format when the
            resource will be valid until.
        email:
          type: string
          nullable: true
          description: >-
            The email address that will receive updates when the
            Customer-Profile resource changes status.
        status_callback:
          type: string
          format: uri
          nullable: true
          description: The URL we call to inform your application of status changes.
        date_created:
          type: string
          format: date-time
          nullable: true
          description: >-
            The date and time in GMT when the resource was created specified in
            [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
        date_updated:
          type: string
          format: date-time
          nullable: true
          description: >-
            The date and time in GMT when the resource was last updated
            specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
            format.
        url:
          type: string
          format: uri
          nullable: true
          description: The absolute URL of the Customer-Profile resource.
        links:
          type: object
          format: uri-map
          nullable: true
          description: The URLs of the Assigned Items of the Customer-Profile resource.
    trust_product_enum_status:
      type: string
      enum:
        - draft
        - pending-review
        - in-review
        - twilio-rejected
        - twilio-approved
    trust_product_enum_end_user_type:
      type: string
      enum:
        - individual
        - business
    trusthub.v1.trust_product.trust_product_channel_endpoint_assignment:
      type: object
      properties:
        sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^RA[0-9a-fA-F]{32}$
          nullable: true
          description: >-
            The unique string that we created to identify the Item Assignment
            resource.
        trust_product_sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^BU[0-9a-fA-F]{32}$
          nullable: true
          description: >-
            The unique string that we created to identify the CustomerProfile
            resource.
        account_sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^AC[0-9a-fA-F]{32}$
          nullable: true
          description: >-
            The SID of the
            [Account](https://www.twilio.com/docs/iam/api/account) that created
            the Item Assignment resource.
        channel_endpoint_type:
          type: string
          nullable: true
          description: 'The type of channel endpoint. eg: phone-number'
        channel_endpoint_sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$
          nullable: true
          description: The SID of an channel endpoint
        date_created:
          type: string
          format: date-time
          nullable: true
          description: >-
            The date and time in GMT when the resource was created specified in
            [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
        url:
          type: string
          format: uri
          nullable: true
          description: The absolute URL of the Identity resource.
    trusthub.v1.trust_product.trust_product_entity_assignment:
      type: object
      properties:
        sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^BV[0-9a-fA-F]{32}$
          nullable: true
          description: >-
            The unique string that we created to identify the Item Assignment
            resource.
        trust_product_sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^BU[0-9a-fA-F]{32}$
          nullable: true
          description: >-
            The unique string that we created to identify the TrustProduct
            resource.
        account_sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^AC[0-9a-fA-F]{32}$
          nullable: true
          description: >-
            The SID of the
            [Account](https://www.twilio.com/docs/iam/api/account) that created
            the Item Assignment resource.
        object_sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$
          nullable: true
          description: >-
            The SID of an object bag that holds information of the different
            items.
        date_created:
          type: string
          format: date-time
          nullable: true
          description: >-
            The date and time in GMT when the resource was created specified in
            [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
        url:
          type: string
          format: uri
          nullable: true
          description: The absolute URL of the Identity resource.
    trusthub.v1.trust_product.trust_product_evaluation:
      type: object
      properties:
        sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^EL[0-9a-fA-F]{32}$
          nullable: true
          description: The unique string that identifies the Evaluation resource.
        account_sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^AC[0-9a-fA-F]{32}$
          nullable: true
          description: >-
            The SID of the
            [Account](https://www.twilio.com/docs/iam/api/account) that created
            the trust_product resource.
        policy_sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^RN[0-9a-fA-F]{32}$
          nullable: true
          description: >-
            The unique string of a policy that is associated to the
            trust_product resource.
        trust_product_sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^BU[0-9a-fA-F]{32}$
          nullable: true
          description: >-
            The unique string that we created to identify the trust_product
            resource.
        status:
          type: string
          $ref: '#/components/schemas/trust_product_evaluation_enum_status'
          nullable: true
          description: The compliance status of the Evaluation resource.
        results:
          type: array
          items: {}
          nullable: true
          description: >-
            The results of the Evaluation which includes the valid and invalid
            attributes.
        date_created:
          type: string
          format: date-time
          nullable: true
        url:
          type: string
          format: uri
          nullable: true
    trust_product_evaluation_enum_status:
      type: string
      enum:
        - compliant
        - noncompliant
    CreateComplianceInquiryRequest:
      type: object
      required:
        - PrimaryProfileSid
      properties:
        PrimaryProfileSid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^BU[0-9a-fA-F]{32}$
          description: >-
            The unique SID identifier of the Primary Customer Profile that
            should be used as a parent. Only necessary when creating a secondary
            Customer Profile.
    UpdateComplianceInquiryRequest:
      type: object
      required:
        - PrimaryProfileSid
      properties:
        PrimaryProfileSid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^BU[0-9a-fA-F]{32}$
          description: >-
            The unique SID identifier of the Primary Customer Profile that
            should be used as a parent. Only necessary when creating a secondary
            Customer Profile.
    CreateComplianceTollfreeInquiryRequest:
      type: object
      required:
        - TollfreePhoneNumber
        - NotificationEmail
      properties:
        TollfreePhoneNumber:
          type: string
          format: phone-number
          description: The Tollfree phone number to be verified
        NotificationEmail:
          type: string
          description: >-
            The email address to receive the notification about the verification
            result.
        BusinessName:
          type: string
          description: The name of the business or organization using the Tollfree number.
        BusinessWebsite:
          type: string
          description: >-
            The website of the business or organization using the Tollfree
            number.
        UseCaseCategories:
          type: array
          items:
            type: string
          description: >-
            The category of the use case for the Tollfree Number. List as many
            are applicable..
        UseCaseSummary:
          type: string
          description: >-
            Use this to further explain how messaging is used by the business or
            organization.
        ProductionMessageSample:
          type: string
          description: An example of message content, i.e. a sample message.
        OptInImageUrls:
          type: array
          items:
            type: string
          description: >-
            Link to an image that shows the opt-in workflow. Multiple images
            allowed and must be a publicly hosted URL.
        OptInType:
          type: string
          $ref: '#/components/schemas/compliance_tollfree_inquiry_enum_opt_in_type'
          description: Describe how a user opts-in to text messages.
        MessageVolume:
          type: string
          description: Estimate monthly volume of messages from the Tollfree Number.
        BusinessStreetAddress:
          type: string
          description: >-
            The address of the business or organization using the Tollfree
            number.
        BusinessStreetAddress2:
          type: string
          description: >-
            The address of the business or organization using the Tollfree
            number.
        BusinessCity:
          type: string
          description: The city of the business or organization using the Tollfree number.
        BusinessStateProvinceRegion:
          type: string
          description: >-
            The state/province/region of the business or organization using the
            Tollfree number.
        BusinessPostalCode:
          type: string
          description: >-
            The postal code of the business or organization using the Tollfree
            number.
        BusinessCountry:
          type: string
          description: >-
            The country of the business or organization using the Tollfree
            number.
        AdditionalInformation:
          type: string
          description: Additional information to be provided for verification.
        BusinessContactFirstName:
          type: string
          description: >-
            The first name of the contact for the business or organization using
            the Tollfree number.
        BusinessContactLastName:
          type: string
          description: >-
            The last name of the contact for the business or organization using
            the Tollfree number.
        BusinessContactEmail:
          type: string
          description: >-
            The email address of the contact for the business or organization
            using the Tollfree number.
        BusinessContactPhone:
          type: string
          format: phone-number
          description: >-
            The phone number of the contact for the business or organization
            using the Tollfree number.
    CreateCustomerProfileRequest:
      type: object
      required:
        - FriendlyName
        - Email
        - PolicySid
      properties:
        FriendlyName:
          type: string
          description: The string that you assigned to describe the resource.
        Email:
          type: string
          description: >-
            The email address that will receive updates when the
            Customer-Profile resource changes status.
        PolicySid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^RN[0-9a-fA-F]{3

# --- truncated at 32 KB (111 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/twilio/refs/heads/main/openapi/trust-hub-openapi-original.yml