Comp AI Offboarding Checklist API

openapi: 3.2.0
info:
  title: Comp AI Offboarding Checklist API
  description: Compliance automation API for SOC 2, ISO 27001, HIPAA, GDPR, evidence collection, policy workflows, Trust Access, security questionnaires, integrations, cloud checks, and device compliance.
  version: '1.0'
  contact: {}
servers:
- url: https://api.trycomp.ai
  description: Production API Server
tags:
- name: Offboarding Checklist
paths:
  /v1/offboarding-checklist/pending:
    get:
      description: Lists members whose offboarding checklist is still incomplete, with their outstanding items, so you can track and finish departing-employee offboarding.
      operationId: OffboardingChecklistController_getPendingOffboardings_v1
      parameters: []
      responses:
        '200':
          description: ''
      security:
      - apikey: []
      summary: Get members with pending offboarding checklists
      tags:
      - Offboarding Checklist
      x-mint:
        metadata:
          title: Get members with pending offboarding | Comp AI API
          sidebarTitle: Get members with pending offboarding checklists
          description: Lists members whose offboarding checklist is still incomplete, with their outstanding items, so you can track and finish departing-employee offboarding.
          og:title: Get members with pending offboarding | Comp AI API
          og:description: Lists members whose offboarding checklist is still incomplete, with their outstanding items, so you can track and finish departing-employee offboarding.
      x-speakeasy-mcp:
        name: get-pending-offboardings
  /v1/offboarding-checklist/template:
    get:
      description: 'Returns the organization''s offboarding checklist template: the ordered set of items every departing member must complete during their offboarding.'
      operationId: OffboardingChecklistController_getTemplate_v1
      parameters: []
      responses:
        '200':
          description: ''
      security:
      - apikey: []
      summary: Get the offboarding checklist template
      tags:
      - Offboarding Checklist
      x-mint:
        metadata:
          title: Get the offboarding checklist template | Comp AI API
          sidebarTitle: Get the offboarding checklist template
          description: 'Returns the organization''s offboarding checklist template: the ordered set of items every departing member must complete during their offboarding.'
          og:title: Get the offboarding checklist template | Comp AI API
          og:description: 'Returns the organization''s offboarding checklist template: the ordered set of items every departing member must complete during their offboarding.'
      x-speakeasy-mcp:
        name: get-template
    post:
      description: Creates a new item in the organization's offboarding checklist template so it appears on every member's offboarding checklist from now on.
      operationId: OffboardingChecklistController_createTemplateItem_v1
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTemplateItemDto'
      responses:
        '201':
          description: ''
      security:
      - apikey: []
      summary: Add an offboarding checklist template item
      tags:
      - Offboarding Checklist
      x-mint:
        metadata:
          title: Add an offboarding checklist template item | Comp AI API
          sidebarTitle: Add an offboarding checklist template item
          description: Creates a new item in the organization's offboarding checklist template so it appears on every member's offboarding checklist from now on.
          og:title: Add an offboarding checklist template item | Comp AI API
          og:description: Creates a new item in the organization's offboarding checklist template so it appears on every member's offboarding checklist from now on.
      x-speakeasy-mcp:
        name: create-template-item
  /v1/offboarding-checklist/template/{id}:
    patch:
      description: Updates an existing offboarding checklist template item by id, changing its label, description, or settings on the organization's offboarding template.
      operationId: OffboardingChecklistController_updateTemplateItem_v1
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTemplateItemDto'
      responses:
        '200':
          description: ''
      security:
      - apikey: []
      summary: Update an offboarding checklist template item
      tags:
      - Offboarding Checklist
      x-mint:
        metadata:
          title: Update an offboarding checklist template item | Comp AI API
          sidebarTitle: Update an offboarding checklist template item
          description: Updates an existing offboarding checklist template item by id, changing its label, description, or settings on the organization's offboarding template.
          og:title: Update an offboarding checklist template item | Comp AI API
          og:description: Updates an existing offboarding checklist template item by id, changing its label, description, or settings on the organization's offboarding template.
      x-speakeasy-mcp:
        name: update-template-item
    delete:
      description: Removes an item from the organization's offboarding checklist template by id so it no longer appears on members' offboarding checklists.
      operationId: OffboardingChecklistController_deleteTemplateItem_v1
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - apikey: []
      summary: Delete an offboarding checklist template item
      tags:
      - Offboarding Checklist
      x-mint:
        metadata:
          title: Delete an offboarding checklist template item | Comp AI API
          sidebarTitle: Delete an offboarding checklist template item
          description: Removes an item from the organization's offboarding checklist template by id so it no longer appears on members' offboarding checklists.
          og:title: Delete an offboarding checklist template item | Comp AI API
          og:description: Removes an item from the organization's offboarding checklist template by id so it no longer appears on members' offboarding checklists.
      x-speakeasy-mcp:
        name: delete-template-item
  /v1/offboarding-checklist/member/{memberId}:
    get:
      description: Returns the offboarding checklist for a specific member, including each item and whether it has been completed, to track that person's offboarding progress.
      operationId: OffboardingChecklistController_getMemberChecklist_v1
      parameters:
      - name: memberId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - apikey: []
      summary: Get a member's offboarding checklist
      tags:
      - Offboarding Checklist
      x-mint:
        metadata:
          title: Get a member's offboarding checklist | Comp AI API
          sidebarTitle: Get a member's offboarding checklist
          description: Returns the offboarding checklist for a specific member, including each item and whether it has been completed, to track that person's offboarding progress.
          og:title: Get a member's offboarding checklist | Comp AI API
          og:description: Returns the offboarding checklist for a specific member, including each item and whether it has been completed, to track that person's offboarding progress.
      x-speakeasy-mcp:
        name: get-member-checklist
  /v1/offboarding-checklist/export-all:
    get:
      description: Exports a zip archive containing the offboarding checklist evidence for every member in the organization, for audits, handovers, or record-keeping.
      operationId: OffboardingChecklistController_exportAllEvidence_v1
      parameters: []
      responses:
        '200':
          description: ''
      security:
      - apikey: []
      summary: Export all offboarding evidence as a zip file
      tags:
      - Offboarding Checklist
      x-mint:
        metadata:
          title: Export all offboarding evidence as a zip file | Comp AI API
          sidebarTitle: Export all offboarding evidence as a zip file
          description: Exports a zip archive containing the offboarding checklist evidence for every member in the organization, for audits, handovers, or record-keeping.
          og:title: Export all offboarding evidence as a zip file | Comp AI API
          og:description: Exports a zip archive containing the offboarding checklist evidence for every member in the organization, for audits, handovers, or record-keeping.
      x-speakeasy-mcp:
        name: offboarding-checklist-export-all-evidence
  /v1/offboarding-checklist/member/{memberId}/export:
    get:
      description: Exports a zip archive of the offboarding checklist evidence collected for a single member, for audit, handover, or record-keeping purposes.
      operationId: OffboardingChecklistController_exportEvidence_v1
      parameters:
      - name: memberId
        required: true
        in: path
        description: Member ID
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - apikey: []
      summary: Export offboarding evidence as a zip file
      tags:
      - Offboarding Checklist
      x-mint:
        metadata:
          title: Export offboarding evidence as a zip file | Comp AI API
          sidebarTitle: Export offboarding evidence as a zip file
          description: Exports a zip archive of the offboarding checklist evidence collected for a single member, for audit, handover, or record-keeping purposes.
          og:title: Export offboarding evidence as a zip file | Comp AI API
          og:description: Exports a zip archive of the offboarding checklist evidence collected for a single member, for audit, handover, or record-keeping purposes.
      x-speakeasy-mcp:
        name: export-evidence
  /v1/offboarding-checklist/member/{memberId}/item/{templateItemId}/complete:
    post:
      description: Marks a specific offboarding checklist item complete for a member, recording who completed it and when, as part of finishing that member's offboarding.
      operationId: OffboardingChecklistController_completeItem_v1
      parameters:
      - name: memberId
        required: true
        in: path
        schema:
          type: string
      - name: templateItemId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompleteChecklistItemDto'
      responses:
        '201':
          description: ''
      security:
      - apikey: []
      summary: Complete an offboarding checklist item
      tags:
      - Offboarding Checklist
      x-mint:
        metadata:
          title: Complete an offboarding checklist item | Comp AI API
          sidebarTitle: Complete an offboarding checklist item
          description: Marks a specific offboarding checklist item complete for a member, recording who completed it and when, as part of finishing that member's offboarding.
          og:title: Complete an offboarding checklist item | Comp AI API
          og:description: Marks a specific offboarding checklist item complete for a member, recording who completed it and when, as part of finishing that member's offboarding.
      x-speakeasy-mcp:
        name: complete-item
    delete:
      description: Reverts a previously completed offboarding checklist item back to incomplete for a member, in case the step was marked done by mistake.
      operationId: OffboardingChecklistController_uncompleteItem_v1
      parameters:
      - name: memberId
        required: true
        in: path
        schema:
          type: string
      - name: templateItemId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - apikey: []
      summary: Reopen an offboarding checklist item
      tags:
      - Offboarding Checklist
      x-mint:
        metadata:
          title: Reopen an offboarding checklist item | Comp AI API
          sidebarTitle: Reopen an offboarding checklist item
          description: Reverts a previously completed offboarding checklist item back to incomplete for a member, in case the step was marked done by mistake.
          og:title: Reopen an offboarding checklist item | Comp AI API
          og:description: Reverts a previously completed offboarding checklist item back to incomplete for a member, in case the step was marked done by mistake.
      x-speakeasy-mcp:
        name: uncomplete-item
  /v1/offboarding-checklist/member/{memberId}/item/{templateItemId}/evidence:
    post:
      description: Attaches a supporting evidence file to a member's completed offboarding checklist item, documenting that the offboarding step was actually carried out.
      operationId: OffboardingChecklistController_uploadEvidence_v1
      parameters:
      - name: memberId
        required: true
        in: path
        schema:
          type: string
      - name: templateItemId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UploadAttachmentDto'
      responses:
        '201':
          description: ''
      security:
      - apikey: []
      summary: Upload evidence for an offboarding checklist item
      tags:
      - Offboarding Checklist
      x-mint:
        metadata:
          title: Upload evidence for an offboarding checklist | Comp AI API
          sidebarTitle: Upload evidence for an offboarding checklist item
          description: Attaches a supporting evidence file to a member's completed offboarding checklist item, documenting that the offboarding step was actually carried out.
          og:title: Upload evidence for an offboarding checklist | Comp AI API
          og:description: Attaches a supporting evidence file to a member's completed offboarding checklist item, documenting that the offboarding step was actually carried out.
      x-speakeasy-mcp:
        name: upload-evidence
  /v1/offboarding-checklist/member/{memberId}/access-revocations:
    get:
      description: Lists the vendors a departing member had access to and whether each has been revoked, so you can confirm all vendor access is removed during offboarding.
      operationId: OffboardingChecklistController_getAccessRevocations_v1
      parameters:
      - name: memberId
        required: true
        in: path
        description: Member ID
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - apikey: []
      summary: Get vendor access revocation status for a member
      tags:
      - Offboarding Checklist
      x-mint:
        metadata:
          title: Get vendor access revocation status for a | Comp AI API
          sidebarTitle: Get vendor access revocation status for a member
          description: Lists the vendors a departing member had access to and whether each has been revoked, so you can confirm all vendor access is removed during offboarding.
          og:title: Get vendor access revocation status for a | Comp AI API
          og:description: Lists the vendors a departing member had access to and whether each has been revoked, so you can confirm all vendor access is removed during offboarding.
      x-speakeasy-mcp:
        name: get-access-revocations
  /v1/offboarding-checklist/member/{memberId}/access-revocations/confirm-all:
    post:
      description: Marks every vendor access record for a departing member as revoked in one step, recording who confirmed it, to complete access removal during offboarding.
      operationId: OffboardingChecklistController_revokeAllVendorAccess_v1
      parameters:
      - name: memberId
        required: true
        in: path
        description: Member ID
        schema:
          type: string
      responses:
        '201':
          description: ''
      security:
      - apikey: []
      summary: Confirm all vendor access as revoked
      tags:
      - Offboarding Checklist
      x-mint:
        metadata:
          title: Confirm all vendor access as revoked | Comp AI API
          sidebarTitle: Confirm all vendor access as revoked
          description: Marks every vendor access record for a departing member as revoked in one step, recording who confirmed it, to complete access removal during offboarding.
          og:title: Confirm all vendor access as revoked | Comp AI API
          og:description: Marks every vendor access record for a departing member as revoked in one step, recording who confirmed it, to complete access removal during offboarding.
      x-speakeasy-mcp:
        name: revoke-all-vendor-access
  /v1/offboarding-checklist/member/{memberId}/access-revocations/{vendorId}:
    post:
      description: Marks a single vendor's access for a departing member as revoked, optionally attaching evidence and notes, as part of offboarding access removal.
      operationId: OffboardingChecklistController_revokeVendorAccess_v1
      parameters:
      - name: memberId
        required: true
        in: path
        description: Member ID
        schema:
          type: string
      - name: vendorId
        required: true
        in: path
        description: Vendor ID
        schema:
          type: string
      responses:
        '201':
          description: ''
      security:
      - apikey: []
      summary: Mark vendor access as revoked
      tags:
      - Offboarding Checklist
      x-mint:
        metadata:
          title: Mark vendor access as revoked | Comp AI API
          sidebarTitle: Mark vendor access as revoked
          description: Marks a single vendor's access for a departing member as revoked, optionally attaching evidence and notes, as part of offboarding access removal.
          og:title: Mark vendor access as revoked | Comp AI API
          og:description: Marks a single vendor's access for a departing member as revoked, optionally attaching evidence and notes, as part of offboarding access removal.
      x-speakeasy-mcp:
        name: revoke-vendor-access
    delete:
      description: Reverses a vendor access revocation for a member, marking that vendor's access as not revoked again, in case it was confirmed by mistake during offboarding.
      operationId: OffboardingChecklistController_undoVendorRevocation_v1
      parameters:
      - name: memberId
        required: true
        in: path
        description: Member ID
        schema:
          type: string
      - name: vendorId
        required: true
        in: path
        description: Vendor ID
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - apikey: []
      summary: Undo vendor access revocation
      tags:
      - Offboarding Checklist
      x-mint:
        metadata:
          title: Undo vendor access revocation | Comp AI API
          sidebarTitle: Undo vendor access revocation
          description: Reverses a vendor access revocation for a member, marking that vendor's access as not revoked again, in case it was confirmed by mistake during offboarding.
          og:title: Undo vendor access revocation | Comp AI API
          og:description: Reverses a vendor access revocation for a member, marking that vendor's access as not revoked again, in case it was confirmed by mistake during offboarding.
      x-speakeasy-mcp:
        name: undo-vendor-revocation
components:
  schemas:
    CompleteChecklistItemDto:
      type: object
      properties:
        notes:
          type: string
          description: Optional notes
        fileName:
          type: string
          description: Evidence file name
        fileType:
          type: string
          description: Evidence file MIME type
        fileData:
          type: string
          description: Base64-encoded evidence file. For the web UI / direct callers. AI/MCP clients should instead upload via /v1/uploads/presign (purpose=evidence) and pass `s3Key` — base64 through an LLM is impractically slow and times out. Provide fileData or s3Key (not both).
        s3Key:
          type: string
          description: Key of an evidence file already uploaded via /v1/uploads/presign (purpose=evidence). The server fetches the bytes from storage — no base64 needed. Provide fileData or s3Key (not both).
    CreateTemplateItemDto:
      type: object
      properties:
        title:
          type: string
          description: Checklist item title
          example: Collect access badges
        description:
          type: string
          description: Guidance text for the admin
        evidenceRequired:
          type: boolean
          description: Whether evidence upload is required
      required:
      - title
    UploadAttachmentDto:
      type: object
      properties:
        fileName:
          type: string
          description: Name of the file
          example: document.pdf
          maxLength: 255
        fileType:
          type: string
          description: MIME type of the file
          example: application/pdf
        fileData:
          type: string
          description: Base64-encoded file contents. For the web UI / direct callers. AI/MCP clients should instead upload via /v1/uploads/presign (purpose=attachment) and pass `s3Key` — base64 through an LLM is impractically slow and times out. Provide exactly one of fileData or s3Key.
          example: iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8/5+hHgAHggJ/PchI7wAAAABJRU5ErkJggg==
        s3Key:
          type: string
          description: Key of a file already uploaded via /v1/uploads/presign (purpose=attachment). The server fetches the bytes from storage — no base64 needed. Provide exactly one of fileData or s3Key.
          example: org_abc123/uploads/attachment/1700000000000-rbac-matrix.xlsx
        description:
          type: string
          description: Description of the attachment
          example: Meeting notes from Q4 planning session
          maxLength: 500
        userId:
          type: string
          description: User ID of the user uploading the attachment (required for API key auth, ignored for JWT auth)
          example: usr_abc123def456
      required:
      - fileName
      - fileType
    UpdateTemplateItemDto:
      type: object
      properties:
        title:
          type: string
        description:
          type: string
        evidenceRequired:
          type: boolean
        sortOrder:
          type: number
        isEnabled:
          type: boolean
  securitySchemes:
    apikey:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for authentication
x-speakeasy-timeout: 120000