Twilio RegulatoryCompliance API

The RegulatoryCompliance API from Twilio — 18 operation(s) for regulatorycompliance.

Documentation

Specifications

Other Resources

OpenAPI Specification

twilio-regulatorycompliance-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: Twilio - Accounts A2p RegulatoryCompliance API
  description: This is the public Twilio REST API.
  termsOfService: https://www.twilio.com/legal/tos
  contact:
    name: Twilio Support
    url: https://support.twilio.com
    email: support@twilio.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.52.0
servers:
- url: https://accounts.twilio.com
tags:
- name: RegulatoryCompliance
paths:
  /v2/RegulatoryCompliance/Bundles:
    servers:
    - url: https://numbers.twilio.com
    description: 'TODO: Resource-level docs'
    x-twilio:
      defaultOutputProperties:
      - sid
      - regulation_sid
      - friendly_name
      pathType: list
      dependentProperties:
        evaluations:
          mapping:
            bundle_sid: sid
          resource_url: /v2/RegulatoryCompliance/Bundles/{bundle_sid}/Evaluations
        item_assignments:
          mapping:
            bundle_sid: sid
          resource_url: /v2/RegulatoryCompliance/Bundles/{bundle_sid}/ItemAssignments
        bundle_copies:
          mapping:
            bundle_sid: sid
          resource_url: /v2/RegulatoryCompliance/Bundles/{bundle_sid}/Copies
        replace_items:
          mapping:
            bundle_sid: sid
          resource_url: /v2/RegulatoryCompliance/Bundles/{bundle_sid}/ReplaceItems
      parent: /RegulatoryCompliance
    post:
      description: Create a new Bundle.
      tags:
      - RegulatoryCompliance
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle'
          description: Created
      security:
      - accountSid_authToken: []
      operationId: CreateBundle
      x-maturity:
      - GA
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateBundleRequest'
    get:
      description: Retrieve a list of all Bundles for an account.
      tags:
      - RegulatoryCompliance
      parameters:
      - name: Status
        in: query
        description: The verification status of the Bundle resource. Please refer to [Bundle Statuses](https://www.twilio.com/docs/phone-numbers/regulatory/api/bundles#bundle-statuses) for more details.
        schema:
          type: string
          $ref: '#/components/schemas/bundle_enum_status'
      - name: FriendlyName
        in: query
        description: The string that you assigned to describe the resource. The column can contain 255 variable characters.
        schema:
          type: string
      - name: RegulationSid
        in: query
        description: The unique string of a [Regulation resource](https://www.twilio.com/docs/phone-numbers/regulatory/api/regulations) that is associated to the Bundle resource.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^RN[0-9a-fA-F]{32}$
      - name: IsoCountry
        in: query
        description: The 2-digit [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Bundle's phone number country ownership request.
        schema:
          type: string
      - name: NumberType
        in: query
        description: The type of phone number of the Bundle's ownership request. Can be `local`, `mobile`, `national`, or `tollfree`.
        schema:
          type: string
      - name: HasValidUntilDate
        in: query
        description: Indicates that the Bundle is a valid Bundle until a specified expiration date.
        schema:
          type: boolean
      - name: SortBy
        in: query
        description: Can be `valid-until` or `date-updated`. Defaults to `date-created`.
        schema:
          type: string
          $ref: '#/components/schemas/bundle_enum_sort_by'
      - name: SortDirection
        in: query
        description: Default is `DESC`. Can be `ASC` or `DESC`.
        schema:
          type: string
          $ref: '#/components/schemas/bundle_enum_sort_direction'
      - name: ValidUntilDate
        in: query
        description: Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) is the acceptable date format.
        schema:
          type: string
          format: date-time
      - name: ValidUntilDate<
        in: query
        description: Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) is the acceptable date format.
        schema:
          type: string
          format: date-time
      - name: ValidUntilDate>
        in: query
        description: Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) is the acceptable date format.
        schema:
          type: string
          format: date-time
      - name: PageSize
        in: query
        description: How many resources to return in each list page. The default is 50, and the maximum is 1000.
        schema:
          type: integer
          minimum: 1
          maximum: 1000
      - name: Page
        in: query
        description: The page index. This value is simply for client state.
        schema:
          type: integer
          minimum: 0
      - name: PageToken
        in: query
        description: The page token. This is provided by the API.
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListBundleResponse'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: ListBundle
      x-maturity:
      - GA
  /v2/RegulatoryCompliance/Bundles/{Sid}:
    servers:
    - url: https://numbers.twilio.com
    description: 'TODO: Resource-level docs'
    x-twilio:
      defaultOutputProperties:
      - sid
      - regulation_sid
      - friendly_name
      pathType: instance
      dependentProperties:
        evaluations:
          mapping:
            bundle_sid: sid
          resource_url: /v2/RegulatoryCompliance/Bundles/{bundle_sid}/Evaluations
        item_assignments:
          mapping:
            bundle_sid: sid
          resource_url: /v2/RegulatoryCompliance/Bundles/{bundle_sid}/ItemAssignments
        bundle_copies:
          mapping:
            bundle_sid: sid
          resource_url: /v2/RegulatoryCompliance/Bundles/{bundle_sid}/Copies
        replace_items:
          mapping:
            bundle_sid: sid
          resource_url: /v2/RegulatoryCompliance/Bundles/{bundle_sid}/ReplaceItems
      parent: /RegulatoryCompliance
    get:
      description: Fetch a specific Bundle instance.
      tags:
      - RegulatoryCompliance
      parameters:
      - name: Sid
        in: path
        description: The unique string that we created to identify the Bundle resource.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^BU[0-9a-fA-F]{32}$
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: FetchBundle
      x-maturity:
      - GA
    post:
      description: Updates a Bundle in an account.
      tags:
      - RegulatoryCompliance
      parameters:
      - name: Sid
        in: path
        description: The unique string that we created to identify the Bundle resource.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^BU[0-9a-fA-F]{32}$
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: UpdateBundle
      x-maturity:
      - GA
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateBundleRequest'
    delete:
      description: Delete a specific Bundle.
      tags:
      - RegulatoryCompliance
      parameters:
      - name: Sid
        in: path
        description: The unique string that we created to identify the Bundle resource.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^BU[0-9a-fA-F]{32}$
        required: true
      responses:
        '204':
          description: The resource was deleted successfully.
      security:
      - accountSid_authToken: []
      operationId: DeleteBundle
      x-maturity:
      - GA
  /v2/RegulatoryCompliance/Bundles/{BundleSid}/Copies:
    servers:
    - url: https://numbers.twilio.com
    description: 'TODO: Resource-level docs'
    x-twilio:
      defaultOutputProperties: []
      pathType: list
      parent: /RegulatoryCompliance/Bundles/{Sid}
      mountName: bundle_copies
    post:
      description: Creates a new copy of a Bundle. It will internally create copies of all the bundle items (identities and documents) of the original bundle
      tags:
      - RegulatoryCompliance
      parameters:
      - name: BundleSid
        in: path
        description: The unique string that identifies the Bundle to be copied.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^BU[0-9a-fA-F]{32}$
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.bundle_copy'
          description: Created
      security:
      - accountSid_authToken: []
      operationId: CreateBundleCopy
      x-maturity:
      - Beta
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateBundleCopyRequest'
    get:
      description: Retrieve a list of all Bundles Copies for a Bundle.
      tags:
      - RegulatoryCompliance
      parameters:
      - name: BundleSid
        in: path
        description: The unique string that we created to identify the Bundle resource.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^BU[0-9a-fA-F]{32}$
        required: true
      - name: PageSize
        in: query
        description: How many resources to return in each list page. The default is 50, and the maximum is 1000.
        schema:
          type: integer
          minimum: 1
          maximum: 1000
      - name: Page
        in: query
        description: The page index. This value is simply for client state.
        schema:
          type: integer
          minimum: 0
      - name: PageToken
        in: query
        description: The page token. This is provided by the API.
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListBundleCopyResponse'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: ListBundleCopy
      x-maturity:
      - Beta
  /v2/RegulatoryCompliance/EndUsers:
    servers:
    - url: https://numbers.twilio.com
    description: 'TODO: Resource-level docs'
    x-twilio:
      defaultOutputProperties:
      - sid
      - friendly_name
      pathType: list
      parent: /RegulatoryCompliance
    post:
      description: Create a new End User.
      tags:
      - RegulatoryCompliance
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/numbers.v2.regulatory_compliance.end_user'
          description: Created
      security:
      - accountSid_authToken: []
      operationId: CreateEndUser
      x-maturity:
      - GA
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateEndUserRequest'
    get:
      description: Retrieve a list of all End User for an account.
      tags:
      - RegulatoryCompliance
      parameters:
      - name: PageSize
        in: query
        description: How many resources to return in each list page. The default is 50, and the maximum is 1000.
        schema:
          type: integer
          minimum: 1
          maximum: 1000
      - name: Page
        in: query
        description: The page index. This value is simply for client state.
        schema:
          type: integer
          minimum: 0
      - name: PageToken
        in: query
        description: The page token. This is provided by the API.
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEndUserResponse'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: ListEndUser
      x-maturity:
      - GA
  /v2/RegulatoryCompliance/EndUsers/{Sid}:
    servers:
    - url: https://numbers.twilio.com
    description: 'TODO: Resource-level docs'
    x-twilio:
      defaultOutputProperties:
      - sid
      - friendly_name
      pathType: instance
      parent: /RegulatoryCompliance
    get:
      description: Fetch specific End User Instance.
      tags:
      - RegulatoryCompliance
      parameters:
      - name: Sid
        in: path
        description: The unique string created by Twilio to identify the End User resource.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^IT[0-9a-fA-F]{32}$
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/numbers.v2.regulatory_compliance.end_user'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: FetchEndUser
      x-maturity:
      - GA
    post:
      description: Update an existing End User.
      tags:
      - RegulatoryCompliance
      parameters:
      - name: Sid
        in: path
        description: The unique string created by Twilio to identify the End User resource.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^IT[0-9a-fA-F]{32}$
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/numbers.v2.regulatory_compliance.end_user'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: UpdateEndUser
      x-maturity:
      - GA
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateEndUserRequest'
    delete:
      description: Delete a specific End User.
      tags:
      - RegulatoryCompliance
      parameters:
      - name: Sid
        in: path
        description: The unique string created by Twilio to identify the End User resource.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^IT[0-9a-fA-F]{32}$
        required: true
      responses:
        '204':
          description: The resource was deleted successfully.
      security:
      - accountSid_authToken: []
      operationId: DeleteEndUser
      x-maturity:
      - GA
  /v2/RegulatoryCompliance/EndUserTypes:
    servers:
    - url: https://numbers.twilio.com
    description: 'TODO: Resource-level docs'
    x-twilio:
      defaultOutputProperties:
      - sid
      - friendly_name
      pathType: list
      parent: /RegulatoryCompliance
    get:
      description: Retrieve a list of all End-User Types.
      tags:
      - RegulatoryCompliance
      parameters:
      - name: PageSize
        in: query
        description: How many resources to return in each list page. The default is 50, and the maximum is 1000.
        schema:
          type: integer
          minimum: 1
          maximum: 1000
      - name: Page
        in: query
        description: The page index. This value is simply for client state.
        schema:
          type: integer
          minimum: 0
      - name: PageToken
        in: query
        description: The page token. This is provided by the API.
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEndUserTypeResponse'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: ListEndUserType
      x-maturity:
      - GA
  /v2/RegulatoryCompliance/EndUserTypes/{Sid}:
    servers:
    - url: https://numbers.twilio.com
    description: 'TODO: Resource-level docs'
    x-twilio:
      defaultOutputProperties:
      - sid
      - friendly_name
      pathType: instance
      parent: /RegulatoryCompliance
    get:
      description: Fetch a specific End-User Type Instance.
      tags:
      - RegulatoryCompliance
      parameters:
      - name: Sid
        in: path
        description: The unique string that identifies the End-User Type resource.
        schema:
          type: string
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/numbers.v2.regulatory_compliance.end_user_type'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: FetchEndUserType
      x-maturity:
      - GA
  /v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations:
    servers:
    - url: https://numbers.twilio.com
    description: 'TODO: Resource-level docs'
    x-twilio:
      defaultOutputProperties:
      - sid
      pathType: list
      parent: /RegulatoryCompliance/Bundles/{Sid}
    post:
      description: Creates an evaluation for a bundle
      tags:
      - RegulatoryCompliance
      parameters:
      - name: BundleSid
        in: path
        description: The unique string that identifies the Bundle resource.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^BU[0-9a-fA-F]{32}$
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.evaluation'
          description: Created
      security:
      - accountSid_authToken: []
      operationId: CreateEvaluation
      x-maturity:
      - GA
    get:
      description: Retrieve a list of Evaluations associated to the Bundle resource.
      tags:
      - RegulatoryCompliance
      parameters:
      - name: BundleSid
        in: path
        description: The unique string that identifies the Bundle resource.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^BU[0-9a-fA-F]{32}$
        required: true
      - name: PageSize
        in: query
        description: How many resources to return in each list page. The default is 50, and the maximum is 1000.
        schema:
          type: integer
          minimum: 1
          maximum: 1000
      - name: Page
        in: query
        description: The page index. This value is simply for client state.
        schema:
          type: integer
          minimum: 0
      - name: PageToken
        in: query
        description: The page token. This is provided by the API.
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEvaluationResponse'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: ListEvaluation
      x-maturity:
      - GA
  /v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations/{Sid}:
    servers:
    - url: https://numbers.twilio.com
    description: 'TODO: Resource-level docs'
    x-twilio:
      defaultOutputProperties:
      - sid
      pathType: instance
      parent: /RegulatoryCompliance/Bundles/{Sid}
    get:
      description: Fetch specific Evaluation Instance.
      tags:
      - RegulatoryCompliance
      parameters:
      - name: BundleSid
        in: path
        description: The unique string that we created to identify the Bundle resource.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^BU[0-9a-fA-F]{32}$
        required: true
      - name: Sid
        in: path
        description: The unique string that identifies the Evaluation resource.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^EL[0-9a-fA-F]{32}$
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.evaluation'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: FetchEvaluation
      x-maturity:
      - GA
  /v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments:
    servers:
    - url: https://numbers.twilio.com
    description: 'TODO: Resource-level docs'
    x-twilio:
      defaultOutputProperties:
      - sid
      pathType: list
      parent: /RegulatoryCompliance/Bundles/{Sid}
    post:
      description: Create a new Assigned Item.
      tags:
      - RegulatoryCompliance
      parameters:
      - name: BundleSid
        in: path
        description: The unique string that we created to identify the Bundle resource.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^BU[0-9a-fA-F]{32}$
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.item_assignment'
          description: Created
      security:
      - accountSid_authToken: []
      operationId: CreateItemAssignment
      x-maturity:
      - GA
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateItemAssignmentRequest'
    get:
      description: Retrieve a list of all Assigned Items for an account.
      tags:
      - RegulatoryCompliance
      parameters:
      - name: BundleSid
        in: path
        description: The unique string that we created to identify the Bundle resource.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^BU[0-9a-fA-F]{32}$
        required: true
      - name: PageSize
        in: query
        description: How many resources to return in each list page. The default is 50, and the maximum is 1000.
        schema:
          type: integer
          minimum: 1
          maximum: 1000
      - name: Page
        in: query
        description: The page index. This value is simply for client state.
        schema:
          type: integer
          minimum: 0
      - name: PageToken
        in: query
        description: The page token. This is provided by the API.
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListItemAssignmentResponse'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: ListItemAssignment
      x-maturity:
      - GA
  /v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments/{Sid}:
    servers:
    - url: https://numbers.twilio.com
    description: 'TODO: Resource-level docs'
    x-twilio:
      defaultOutputProperties:
      - sid
      pathType: instance
      parent: /RegulatoryCompliance/Bundles/{Sid}
    get:
      description: Fetch specific Assigned Item Instance.
      tags:
      - RegulatoryCompliance
      parameters:
      - name: BundleSid
        in: path
        description: The unique string that we created to identify the Bundle resource.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^BU[0-9a-fA-F]{32}$
        required: true
      - name: Sid
        in: path
        description: The unique string that we created to identify the Identity resource.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^BV[0-9a-fA-F]{32}$
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.item_assignment'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: FetchItemAssignment
      x-maturity:
      - GA
    delete:
      description: Remove an Assignment Item Instance.
      tags:
      - RegulatoryCompliance
      parameters:
      - name: BundleSid
        in: path
        description: The unique string that we created to identify the Bundle resource.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^BU[0-9a-fA-F]{32}$
        required: true
      - name: Sid
        in: path
        description: The unique string that we created to identify the Identity resource.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^BV[0-9a-fA-F]{32}$
        required: true
      responses:
        '204':
          description: The resource was deleted successfully.
      security:
      - accountSid_authToken: []
      operationId: DeleteItemAssignment
      x-maturity:
      - GA
  /v2/RegulatoryCompliance/Regulations:
    servers:
    - url: https://numbers.twilio.com
    description: 'TODO: Resource-level docs'
    x-twilio:
      defaultOutputProperties:
      - sid
      - friendly_name
      pathType: list
      parent: /RegulatoryCompliance
    get:
      description: Retrieve a list of all Regulations.
      tags:
      - RegulatoryCompliance
      parameters:
      - name: EndUserType
        in: query
        description: The type of End User the regulation requires - can be `individual` or `business`.
        schema:
          type: string
          $ref: '#/components/schemas/regulation_enum_end_user_type'
      - name: IsoCountry
        in: query
        description: The ISO country code of the phone number's country.
        schema:
          type: string
      - name: NumberType
        in: query
        description: The type of phone number that the regulatory requiremnt is restricting.
        schema:
          type: string
      - name: PageSize
        in: query
        description: How many resources to return in each list page. The default is 50, and the maximum is 1000.
        schema:
          type: integer
          minimum: 1
          maximum: 1000
      - name: Page
        in: query
        description: The page index. This value is simply for client state.
        schema:
          type: integer
          minimum: 0
      - name: PageToken
        in: query
        description: The page token. This is provided by the API.
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListRegulationResponse'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: ListRegulation
      x-maturity:
      - GA
  /v2/RegulatoryCompliance/Regulations/{Sid}:
    servers:
    - url: https://numbers.twilio.com
    description: 'TODO: Resource-level docs'
    x-twilio:
      defaultOutputProperties:
      - sid
      - friendly_name
      pathType: instance
      parent: /RegulatoryCompliance
    get:
      description: Fetch specific Regulation Instance.
      tags:
      - RegulatoryCompliance
      parameters:
      - name: Sid
        in: path
        description: The unique string that identifies the Regulation resource.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^RN[0-9a-fA-F]{32}$
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/numbers.v2.regulatory_compliance.regulation'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: FetchRegulation
      x-maturity:
      - GA
  /v2/RegulatoryCompliance/Bundles/{BundleSid}/ReplaceItems:
    servers:
    - url: https://numbers.twilio.com
    description: 'TODO: Resource-level docs'
    x-twilio:
      defaultOutputProperties: []
      pathType: list
      parent: /RegulatoryCompliance/Bundles/{Sid}
      className: replace_items
    post:
      description: Replaces all bundle items in the target bundle (specified in the path) with all the bundle items of the source bundle (specified by the from_bundle_sid body param)
      tags:
      - RegulatoryCompliance
      parameters:
      - name: BundleSid
        in: path
        description: The unique string that identifies the Bundle where the item assignments are going to be replaced.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^BU[0-9a-fA-F]{32}$
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/numbers.v2.regulatory_compliance.bundle.replace_items'
          description: Created
      security:
      - accountSid_authToken: []
      operationId: CreateReplaceItems
      x-maturity:
      - Beta
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateReplaceItemsRequest'
  /v2/RegulatoryCompliance/SupportingDocuments:
    servers:
    - url: https://numbers.twilio.com
    description: 'TODO: Resource-level docs'
    x-twilio:
      defaultOutputProperties:
      - sid
      - friendly_name
      pathType: list
      parent: /RegulatoryCompliance
    post:
      description: Create a new Supporting Document.
      tags:
      - RegulatoryCompliance
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/numbers.v2.regulatory_compliance.supporting_document'
          description: Created
      security:
      - accountSid_authToken: []
      operationId: CreateSupportingDocument
      x-maturity:
      - GA
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateSupportingDocumentRequest'
    get:
      description: Retrieve a list of all Supporting Document for an account.
      tags:
      - RegulatoryCompliance
      parameters:
      - name: PageSize
        in: query
        description: How many resources to return in each list page. The default is 50, and the maximum is 1000.
        schema:
          type: integer
          minimum: 1
          maximum: 1000
      - name: Page
        in: query
        description: The page index. This value is simply for client state.
        schema:
          type: integer
          minimum: 0
      - name: PageToken
        in: query
        description: The page token. This is provided by the API.
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSupportingDocu

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