Comp AI Trust Access API

openapi: 3.2.0
info:
  title: Comp AI Trust Access 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: Trust Access
  description: Manage external Trust Center access requests, NDA signing, grants, tokenized document downloads, public FAQs, and reviewer access.
paths:
  /v1/trust-access/{friendlyUrl}/requests:
    post:
      description: Queue a Trust Center access request for administrator review. Returns a generic acknowledgment; approved access links are delivered only by email.
      operationId: TrustAccessController_createAccessRequest_v1
      parameters:
      - name: friendlyUrl
        required: true
        in: path
        description: Trust Portal friendly URL or Organization ID
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAccessRequestDto'
      responses:
        '201':
          description: Access request queued for processing
        '503':
          description: Access submission queue is temporarily unavailable
      summary: Submit Trust Access request
      tags:
      - Trust Access
      x-mint:
        metadata:
          title: Submit Trust Access request | Comp AI API
          sidebarTitle: Submit Trust Access request
          description: Queue a Trust Center access request for administrator review. Returns a generic acknowledgment; approved access links are delivered only by email.
          og:title: Submit Trust Access request | Comp AI API
          og:description: Queue a Trust Center access request for administrator review. Returns a generic acknowledgment; approved access links are delivered only by email.
      x-speakeasy-mcp:
        name: create-access-request
  /v1/trust-access/admin/requests:
    get:
      description: List pending and completed Trust Center access requests so teams can review customer security inquiries through the API.
      operationId: TrustAccessController_listAccessRequests_v1
      parameters:
      - name: status
        required: false
        in: query
        schema:
          type: string
          enum:
          - under_review
          - approved
          - denied
          - canceled
      responses:
        '200':
          description: Access requests retrieved
      security:
      - apikey: []
      summary: List Trust Access requests
      tags:
      - Trust Access
      x-mint:
        metadata:
          title: List Trust Access requests | Comp AI API
          sidebarTitle: List Trust Access requests
          description: List pending and completed Trust Center access requests so teams can review customer security inquiries through the API.
          og:title: List Trust Access requests | Comp AI API
          og:description: List pending and completed Trust Center access requests so teams can review customer security inquiries through the API.
      x-speakeasy-mcp:
        name: list-access-requests
  /v1/trust-access/admin/requests/{id}:
    get:
      description: Retrieve one Trust Center access request with requester context, status, review metadata, and audit details.
      operationId: TrustAccessController_getAccessRequest_v1
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: Request details returned
      security:
      - apikey: []
      summary: Get Trust Access request
      tags:
      - Trust Access
      x-mint:
        metadata:
          title: Get Trust Access request | Comp AI API
          sidebarTitle: Get Trust Access request
          description: Retrieve one Trust Center access request with requester context, status, review metadata, and audit details.
          og:title: Get Trust Access request | Comp AI API
          og:description: Retrieve one Trust Center access request with requester context, status, review metadata, and audit details.
      x-speakeasy-mcp:
        name: get-access-request
  /v1/trust-access/admin/requests/{id}/approve:
    post:
      description: Approve a Trust Center access request, configure the grant window, and start the NDA or access email workflow.
      operationId: TrustAccessController_approveRequest_v1
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApproveAccessRequestDto'
      responses:
        '200':
          description: Request approved successfully
      security:
      - apikey: []
      summary: Approve Trust Access request
      tags:
      - Trust Access
      x-mint:
        metadata:
          title: Approve Trust Access request | Comp AI API
          sidebarTitle: Approve Trust Access request
          description: Approve a Trust Center access request, configure the grant window, and start the NDA or access email workflow.
          og:title: Approve Trust Access request | Comp AI API
          og:description: Approve a Trust Center access request, configure the grant window, and start the NDA or access email workflow.
      x-speakeasy-mcp:
        name: approve-request
  /v1/trust-access/admin/requests/{id}/deny:
    post:
      description: Reject a Trust Center access request with a review reason so customer security access decisions stay auditable.
      operationId: TrustAccessController_denyRequest_v1
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DenyAccessRequestDto'
      responses:
        '200':
          description: Request denied
      security:
      - apikey: []
      summary: Deny Trust Access request
      tags:
      - Trust Access
      x-mint:
        metadata:
          title: Deny Trust Access request | Comp AI API
          sidebarTitle: Deny Trust Access request
          description: Reject a Trust Center access request with a review reason so customer security access decisions stay auditable.
          og:title: Deny Trust Access request | Comp AI API
          og:description: Reject a Trust Center access request with a review reason so customer security access decisions stay auditable.
      x-speakeasy-mcp:
        name: deny-request
  /v1/trust-access/admin/grants:
    get:
      description: List active, expired, and revoked Trust Access grants for customer security reviews and shared compliance resources.
      operationId: TrustAccessController_listGrants_v1
      parameters: []
      responses:
        '200':
          description: Grants retrieved
      security:
      - apikey: []
      summary: List Trust Access grants
      tags:
      - Trust Access
      x-mint:
        metadata:
          title: List Trust Access grants | Comp AI API
          sidebarTitle: List Trust Access grants
          description: List active, expired, and revoked Trust Access grants for customer security reviews and shared compliance resources.
          og:title: List Trust Access grants | Comp AI API
          og:description: List active, expired, and revoked Trust Access grants for customer security reviews and shared compliance resources.
      x-speakeasy-mcp:
        name: list-grants
  /v1/trust-access/admin/grants/{id}/revoke:
    post:
      description: Immediately revoke a Trust Access grant when a customer review ends or shared compliance access should be removed.
      operationId: TrustAccessController_revokeGrant_v1
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RevokeGrantDto'
      responses:
        '200':
          description: Grant revoked
      security:
      - apikey: []
      summary: Revoke Trust Access grant
      tags:
      - Trust Access
      x-mint:
        metadata:
          title: Revoke Trust Access grant | Comp AI API
          sidebarTitle: Revoke Trust Access grant
          description: Immediately revoke a Trust Access grant when a customer review ends or shared compliance access should be removed.
          og:title: Revoke Trust Access grant | Comp AI API
          og:description: Immediately revoke a Trust Access grant when a customer review ends or shared compliance access should be removed.
      x-speakeasy-mcp:
        name: revoke-grant
  /v1/trust-access/admin/grants/{id}/resend-access-email:
    post:
      description: Resend the access email for an active Trust Access grant so approved reviewers can reopen shared resources.
      operationId: TrustAccessController_resendAccessEmail_v1
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: Access email resent
      security:
      - apikey: []
      summary: Resend Trust Access email
      tags:
      - Trust Access
      x-mint:
        metadata:
          title: Resend Trust Access email | Comp AI API
          sidebarTitle: Resend Trust Access email
          description: Resend the access email for an active Trust Access grant so approved reviewers can reopen shared resources.
          og:title: Resend Trust Access email | Comp AI API
          og:description: Resend the access email for an active Trust Access grant so approved reviewers can reopen shared resources.
      x-speakeasy-mcp:
        name: resend-access-email
  /v1/trust-access/admin/requests/{id}/resend-nda:
    post:
      description: Resend an NDA signing email for a Trust Access request that still requires reviewer signature.
      operationId: TrustAccessController_resendNda_v1
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: NDA email resent
      security:
      - apikey: []
      summary: Resend Trust Access NDA
      tags:
      - Trust Access
      x-mint:
        metadata:
          title: Resend Trust Access NDA | Comp AI API
          sidebarTitle: Resend Trust Access NDA
          description: Resend an NDA signing email for a Trust Access request that still requires reviewer signature.
          og:title: Resend Trust Access NDA | Comp AI API
          og:description: Resend an NDA signing email for a Trust Access request that still requires reviewer signature.
      x-speakeasy-mcp:
        name: resend-nda
  /v1/trust-access/admin/requests/{id}/preview-nda:
    post:
      description: Generate a preview NDA PDF for a Trust Access request before the reviewer signs and receives access.
      operationId: TrustAccessController_previewNda_v1
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: Preview NDA generated
      security:
      - apikey: []
      summary: Preview Trust Access NDA
      tags:
      - Trust Access
      x-mint:
        metadata:
          title: Preview Trust Access NDA | Comp AI API
          sidebarTitle: Preview Trust Access NDA
          description: Generate a preview NDA PDF for a Trust Access request before the reviewer signs and receives access.
          og:title: Preview Trust Access NDA | Comp AI API
          og:description: Generate a preview NDA PDF for a Trust Access request before the reviewer signs and receives access.
      x-speakeasy-mcp:
        name: preview-nda
  /v1/trust-access/{friendlyUrl}/reclaim:
    post:
      description: Queue an access-link email for a published Trust Center. Returns a generic acknowledgment whether or not the reviewer has an active grant.
      operationId: TrustAccessController_reclaimAccess_v1
      parameters:
      - name: friendlyUrl
        required: true
        in: path
        description: Trust Portal friendly URL or Organization ID
        schema:
          type: string
      - name: query
        required: false
        in: query
        description: Query parameter to append to the access link (e.g., security-questionnaire)
        schema:
          example: security-questionnaire
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReclaimAccessDto'
      responses:
        '200':
          description: Generic confirmation message, identical whether or not an active access grant exists for the email (no access link or token is returned).
        '503':
          description: Access submission queue is temporarily unavailable
      summary: Reclaim Trust Access link
      tags:
      - Trust Access
      x-mint:
        metadata:
          title: Reclaim Trust Access link | Comp AI API
          sidebarTitle: Reclaim Trust Access link
          description: Queue an access-link email for a published Trust Center. Returns a generic acknowledgment whether or not the reviewer has an active grant.
          og:title: Reclaim Trust Access link | Comp AI API
          og:description: Queue an access-link email for a published Trust Center. Returns a generic acknowledgment whether or not the reviewer has an active grant.
      x-speakeasy-mcp:
        name: reclaim-access
  /v1/trust-access/{friendlyUrl}/faqs:
    get:
      description: Retrieve published Trust Center FAQs for an organization so public trust pages can show customer security answers.
      operationId: TrustAccessController_getFaqs_v1
      parameters:
      - name: friendlyUrl
        required: true
        in: path
        description: Trust Portal friendly URL or Organization ID
        schema:
          type: string
      responses:
        '200':
          description: FAQs retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  faqs:
                    type:
                    - array
                    - 'null'
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        question:
                          type: string
                        answer:
                          type: string
                        order:
                          type: number
        '404':
          description: Trust site not found or not published
      summary: Get Trust Center FAQs
      tags:
      - Trust Access
      x-mint:
        metadata:
          title: Get Trust Center FAQs | Comp AI API
          sidebarTitle: Get Trust Center FAQs
          description: Retrieve published Trust Center FAQs for an organization so public trust pages can show customer security answers.
          og:title: Get Trust Center FAQs | Comp AI API
          og:description: Retrieve published Trust Center FAQs for an organization so public trust pages can show customer security answers.
      x-speakeasy-mcp:
        name: get-faqs
  /v1/trust-access/{friendlyUrl}/overview:
    get:
      description: Retrieve the published Trust Center overview for an organization, including public security posture messaging.
      operationId: TrustAccessController_getPublicOverview_v1
      parameters:
      - name: friendlyUrl
        required: true
        in: path
        description: Trust Portal friendly URL or Organization ID
        schema:
          type: string
      responses:
        '200':
          description: Overview retrieved successfully
      summary: Get Trust Center overview
      tags:
      - Trust Access
      x-mint:
        metadata:
          title: Get Trust Center overview | Comp AI API
          sidebarTitle: Get Trust Center overview
          description: Retrieve the published Trust Center overview for an organization, including public security posture messaging.
          og:title: Get Trust Center overview | Comp AI API
          og:description: Retrieve the published Trust Center overview for an organization, including public security posture messaging.
      x-speakeasy-mcp:
        name: get-public-overview
  /v1/trust-access/{friendlyUrl}/security-questionnaire:
    get:
      description: Whether the org offers the AI-assisted Security Questionnaire on its public trust portal. Defaults to enabled when the portal can't be resolved.
      operationId: TrustAccessController_getPublicSecurityQuestionnaire_v1
      parameters:
      - name: friendlyUrl
        required: true
        in: path
        description: Trust Portal friendly URL or Organization ID
        schema:
          type: string
      responses:
        '200':
          description: Security Questionnaire visibility retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  enabled:
                    type: boolean
      summary: Get Security Questionnaire visibility for a trust portal
      tags:
      - Trust Access
      x-mint:
        metadata:
          title: Get Security Questionnaire visibility for a | Comp AI API
          sidebarTitle: Get Security Questionnaire visibility for a trust portal
          description: Whether the org offers the AI-assisted Security Questionnaire on its public trust portal. Defaults to enabled when the portal can't be resolved.
          og:title: Get Security Questionnaire visibility for a | Comp AI API
          og:description: Whether the org offers the AI-assisted Security Questionnaire on its public trust portal. Defaults to enabled when the portal can't be resolved.
      x-speakeasy-mcp:
        name: get-public-security-questionnaire
  /v1/trust-access/{friendlyUrl}/custom-links:
    get:
      description: List published custom links shown on an organization Trust Center for customer security and compliance reviews.
      operationId: TrustAccessController_getPublicCustomLinks_v1
      parameters:
      - name: friendlyUrl
        required: true
        in: path
        description: Trust Portal friendly URL or Organization ID
        schema:
          type: string
      responses:
        '200':
          description: Custom links retrieved successfully
      summary: List Trust Center custom links
      tags:
      - Trust Access
      x-mint:
        metadata:
          title: List Trust Center custom links | Comp AI API
          sidebarTitle: List Trust Center custom links
          description: List published custom links shown on an organization Trust Center for customer security and compliance reviews.
          og:title: List Trust Center custom links | Comp AI API
          og:description: List published custom links shown on an organization Trust Center for customer security and compliance reviews.
      x-speakeasy-mcp:
        name: get-public-custom-links
  /v1/trust-access/{friendlyUrl}/favicon:
    get:
      description: Retrieve the favicon URL used by a published Trust Center so embedded or mirrored experiences can match branding.
      operationId: TrustAccessController_getPublicFavicon_v1
      parameters:
      - name: friendlyUrl
        required: true
        in: path
        description: Trust Portal friendly URL or Organization ID
        schema:
          type: string
      responses:
        '200':
          description: Favicon URL retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  faviconUrl:
                    type:
                    - string
                    - 'null'
                    description: Signed URL to the favicon, or null if not set
      summary: Get Trust Center favicon
      tags:
      - Trust Access
      x-mint:
        metadata:
          title: Get Trust Center favicon | Comp AI API
          sidebarTitle: Get Trust Center favicon
          description: Retrieve the favicon URL used by a published Trust Center so embedded or mirrored experiences can match branding.
          og:title: Get Trust Center favicon | Comp AI API
          og:description: Retrieve the favicon URL used by a published Trust Center so embedded or mirrored experiences can match branding.
      x-speakeasy-mcp:
        name: get-public-favicon
  /v1/trust-access/{friendlyUrl}/vendors:
    get:
      description: List published vendors and subprocessors for an organization Trust Center so reviewers can inspect third-party posture.
      operationId: TrustAccessController_getPublicVendors_v1
      parameters:
      - name: friendlyUrl
        required: true
        in: path
        description: Trust Portal friendly URL or Organization ID
        schema:
          type: string
      responses:
        '200':
          description: Vendors retrieved successfully
      summary: List Trust Center vendors
      tags:
      - Trust Access
      x-mint:
        metadata:
          title: List Trust Center vendors | Comp AI API
          sidebarTitle: List Trust Center vendors
          description: List published vendors and subprocessors for an organization Trust Center so reviewers can inspect third-party posture.
          og:title: List Trust Center vendors | Comp AI API
          og:description: List published vendors and subprocessors for an organization Trust Center so reviewers can inspect third-party posture.
      x-speakeasy-mcp:
        name: get-public-vendors
  /v1/trust-access/{friendlyUrl}/custom-frameworks:
    get:
      description: Get org-authored custom frameworks shown on a trust portal in Comp AI. Manage external Trust Center access requests, NDA signing, grants, tokenized document downloads, public FAQs, and reviewer access.
      operationId: TrustAccessController_getPublicCustomFrameworks_v1
      parameters:
      - name: friendlyUrl
        required: true
        in: path
        description: Trust Portal friendly URL or Organization ID
        schema:
          type: string
      responses:
        '200':
          description: Custom frameworks retrieved successfully
      summary: Get org-authored custom frameworks shown on a trust portal
      tags:
      - Trust Access
      x-mint:
        metadata:
          title: Get org-authored custom frameworks shown on a | Comp AI API
          sidebarTitle: Get org-authored custom frameworks shown on a trust portal
          description: Get org-authored custom frameworks shown on a trust portal in Comp AI. Manage external Trust Center access requests, NDA signing, grants, tokenized document.
          og:title: Get org-authored custom frameworks shown on a | Comp AI API
          og:description: Get org-authored custom frameworks shown on a trust portal in Comp AI. Manage external Trust Center access requests, NDA signing, grants, tokenized document.
      x-speakeasy-mcp:
        name: get-public-custom-frameworks
components:
  schemas:
    ApproveAccessRequestDto:
      type: object
      properties:
        durationDays:
          type: number
          minimum: 1
    DenyAccessRequestDto:
      type: object
      properties:
        reason:
          type: string
      required:
      - reason
    CreateAccessRequestDto:
      type: object
      properties:
        name:
          type: string
        email:
          type: string
        company:
          type: string
        jobTitle:
          type: string
        purpose:
          type: string
        requestedDurationDays:
          type: number
          minimum: 1
      required:
      - name
      - email
    RevokeGrantDto:
      type: object
      properties:
        reason:
          type: string
      required:
      - reason
    ReclaimAccessDto:
      type: object
      properties:
        email:
          type: string
      required:
      - email
  securitySchemes:
    apikey:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for authentication
x-speakeasy-timeout: 120000