> ## Documentation Index
> Fetch the complete documentation index at: https://docs.msportal.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a compliance check definition

> Create a base check definition (pending review); groupIds sets exact group membership. Staff only. Scope compliance.write; permission write_compliance or manage_compliance.



## OpenAPI

````yaml /openapi.json post /api/public/v1/compliance/templates
openapi: 3.0.3
info:
  title: MSPortal Public API
  version: 1.0.0
  description: >-
    Public API for MSPortal - provides programmatic access to tenant data.


    ## Authentication


    All endpoints require authentication via API key passed as a Bearer token:


    ```

    Authorization: Bearer <your-api-key>

    ```


    API keys can be created in the MSPortal dashboard under Settings →
    Integrations → API Access.


    **Important:** Do not include cookies in API requests. The public API uses
    stateless authentication only.


    ## Scopes


    API keys are granted specific scopes that determine what operations they can
    perform. Each endpoint documents its required scope(s).


    ## Rate Limiting


    API calls are rate limited per API key. Rate limit information is returned
    in response headers:


    - `X-RateLimit-Limit`: Maximum requests per minute

    - `X-RateLimit-Remaining`: Remaining requests in current window

    - `X-RateLimit-Reset`: When the rate limit resets (ISO 8601)


    ## Request ID


    All responses include an `X-Request-Id` header for debugging and support.
    You can also pass your own `X-Request-Id` header to correlate requests.
  contact:
    name: MSPortal Support
    email: support@msportal.ai
  license:
    name: Proprietary
servers:
  - url: https://app.msportal.ai
    description: Production (US)
  - url: https://eu.msportal.ai
    description: Production (EU)
security:
  - BearerAuth: []
tags:
  - name: Budgets
    description: >-
      Budget management - create, track, and forecast budgets with line items,
      categories, and products
  - name: Calendar
    description: Calendar and meeting management - events, participants, and meeting types
  - name: Companies
    description: Company management endpoints
  - name: Company Users
    description: Company user management - client portal contacts (read-only, paginated)
  - name: Compliance
    description: Compliance check management - runs, assigned checks, and status updates
  - name: Dashboards
    description: Dashboard management - external iframe resources and internal dashboards
  - name: Devices
    description: Device management - inventory, types, and locations
  - name: Goals
    description: Goal management - create, track, and manage goals with tasks and updates
  - name: NPS Surveys
    description: >-
      NPS survey management - Net Promoter Score surveys, responses, and
      analytics
  - name: Reports
    description: >-
      Report management - create, manage, and schedule reports with templates
      and types
  - name: Planner
    description: >-
      Planner item management - tasks, roadmap items, and project planning with
      linked goals, compliance, and projects
  - name: Surveys
    description: >-
      General survey management - multi-question surveys, responses, and
      statistics
  - name: Tickets
    description: Ticket management - view and filter tickets from PSA integrations
  - name: Training
    description: >-
      Training management - courses, enrollments, certificates, and progress
      tracking
  - name: Users
    description: Tenant user management - internal staff and team members (read-only)
  - name: Automation Rules
    description: >-
      Automation rule management - create, configure, and monitor automation
      rules with triggers, conditions, and actions
  - name: Analytics
    description: >-
      Analytics and reporting - company audit data, training analytics, user
      activity, and portfolio metrics
  - name: Client Onboarding
    description: >-
      Client onboarding - portals (phases, tasks, contacts, activation),
      templates, checklist templates, forms and documentation pages
  - name: Backup
    description: >-
      Backup - summaries, protected devices, alerts and SaaS protection (Datto,
      Axcient, Slide, Kaseya)
  - name: Microsoft 365
    description: Microsoft 365 - licenses, users, domains and Secure Score
  - name: Security
    description: >-
      Security - posture summary, EDR incidents, vulnerabilities, email threats,
      firewalls, DNS filtering and security awareness
  - name: Financial
    description: Financial - quotes, invoices and revenue summaries
  - name: Integrations
    description: Integrations - status, sync health, pause and resume (never credentials)
  - name: Documentation
    description: >-
      Documentation - pages, folders and articles synced from Hudu or IT Glue,
      plus built-in pages
  - name: Broadcasts
    description: Broadcasts - emergency broadcasts, recipients and groups
  - name: Notifications
    description: Notifications - the linked user's in-app notifications
  - name: Standards
    description: >-
      Standards - technology standards catalog, service plans, applicability,
      deployment statuses, compliance rollups, white space and costs
  - name: Customer Success
    description: >-
      Customer success - client health scores, trends, benchmarks and Traffic
      Light Reviews
  - name: Tasks
    description: Tasks - the linked user's personal task list
  - name: Tenant Setup
    description: Tenant setup - profile, branding and portal settings (never secrets)
  - name: Roles
    description: Roles - staff and client roles and their permission grants
  - name: Ticket Templates
    description: Ticket templates - reusable ticket definitions
  - name: Readiness
    description: Client readiness - account readiness assessments
  - name: Projects
    description: >-
      Projects - PSA projects with health overlays (deliverables, milestones,
      client actions, weekly updates), phases, tickets, time entries, PSA
      status/owner/priority write-through, ticket notes, task controls, display
      settings and the document library
paths:
  /api/public/v1/compliance/templates:
    post:
      tags:
        - Compliance
      summary: Create a compliance check definition
      description: >-
        Create a base check definition (pending review); groupIds sets exact
        group membership. Staff only. Scope compliance.write; permission
        write_compliance or manage_compliance.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateComplianceTemplateRequest'
      responses:
        '201':
          description: Created check definition
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ComplianceTemplateDetail'
                required:
                  - data
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: >-
            Forbidden - missing scope (compliance.write) or the linked user
            lacks the compliance permission
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: >-
            A referenced group, status list, risk category, folder or compliance
            type was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    CreateComplianceTemplateRequest:
      type: object
      properties:
        title:
          type: string
          minLength: 1
          maxLength: 255
        description:
          type: string
          nullable: true
          maxLength: 5000
          description: null or blank clears
        howToCheck:
          type: string
          nullable: true
          maxLength: 10000
          description: null or blank clears
        whyImportant:
          type: string
          nullable: true
          maxLength: 5000
          description: null or blank clears
        remediation:
          type: string
          nullable: true
          maxLength: 10000
          description: null or blank clears
        remediationImpact:
          type: string
          nullable: true
          maxLength: 5000
          description: null or blank clears
        references:
          type: string
          nullable: true
          maxLength: 5000
          description: null or blank clears
        defaultValue:
          type: string
          nullable: true
          maxLength: 5000
          description: null or blank clears
        criticality:
          type: integer
          minimum: 1
          maximum: 5
        priority:
          type: string
          enum:
            - High
            - Medium
            - Low
        frequency:
          type: string
          nullable: true
          enum:
            - Daily
            - Weekly
            - Bi-weekly
            - Monthly
            - Quarterly
            - Semi-annually
            - Annually
            - null
        checkScope:
          type: string
          nullable: true
          enum:
            - company
            - device
            - location
            - null
        statusListId:
          type: string
          nullable: true
          format: uuid
        complianceTypeId:
          type: integer
          nullable: true
          minimum: 1
        defaultRiskCategoryId:
          type: string
          nullable: true
          format: uuid
        folderId:
          type: string
          nullable: true
          format: uuid
        groupIds:
          type: array
          items:
            type: string
            format: uuid
          maxItems: 500
          description: Exact group membership; an empty array clears it
      required:
        - title
    ComplianceTemplateDetail:
      allOf:
        - $ref: '#/components/schemas/ComplianceTemplate'
        - type: object
          properties:
            defaultValue:
              type: string
              nullable: true
            statusListId:
              type: string
              nullable: true
              format: uuid
            defaultRiskCategoryId:
              type: string
              nullable: true
              format: uuid
            folderId:
              type: string
              nullable: true
              format: uuid
            groupIds:
              type: array
              items:
                type: string
                format: uuid
              description: Exact group membership
            evaluatorKey:
              type: string
              nullable: true
              description: Present only while automatic checks are on
            evaluatorMode:
              type: string
              nullable: true
          required:
            - defaultValue
            - statusListId
            - defaultRiskCategoryId
            - folderId
            - groupIds
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error message
        requestId:
          type: string
          description: Request correlation ID
        details:
          nullable: true
          description: Additional error details
        code:
          type: string
          description: Error code
      required:
        - error
    ComplianceTemplate:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique template identifier
        title:
          type: string
          description: Check title
        description:
          type: string
          nullable: true
          description: Check description
        howToCheck:
          type: string
          nullable: true
          description: Instructions on how to perform the check
        whyImportant:
          type: string
          nullable: true
          description: Explanation of why this check matters
        criticality:
          type: integer
          minimum: 1
          maximum: 10
          description: Criticality score (1-10)
        priority:
          type: string
          enum:
            - High
            - Medium
            - Low
          description: Priority level
        frequency:
          type: string
          nullable: true
          description: Recommended check frequency
        remediation:
          type: string
          nullable: true
          description: Remediation steps if check fails
        remediationImpact:
          type: string
          nullable: true
          description: Impact of performing remediation
        references:
          type: string
          nullable: true
          description: Reference links or documentation
        checkScope:
          type: string
          nullable: true
          enum:
            - company
            - device
            - location
            - null
          description: Scope of the check
        complianceTypeId:
          type: number
          nullable: true
          description: Compliance type ID
        complianceTypeName:
          type: string
          nullable: true
          description: Compliance type name
        approvalStatus:
          type: string
          nullable: true
          enum:
            - draft
            - pending_review
            - approved
            - rejected
            - null
          description: Approval workflow status
        createdAt:
          type: string
          format: date-time
          description: Creation timestamp (ISO 8601)
        updatedAt:
          type: string
          format: date-time
          description: Last update timestamp (ISO 8601)
      required:
        - id
        - title
        - description
        - howToCheck
        - whyImportant
        - criticality
        - priority
        - frequency
        - remediation
        - remediationImpact
        - references
        - checkScope
        - complianceTypeId
        - complianceTypeName
        - approvalStatus
        - createdAt
        - updatedAt
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Use your API key as a Bearer token. API keys can be generated in
        Settings → Integrations → API Access.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.