4chems Consents API

openapi: 3.2.0
info:
  title: platform-api Consents API
  description: 'Platform API: infrastructure, operational, and customer tiers.'
  version: 0.12.1
tags:
- name: Consents
paths:
  /v1/consents:
    post:
      tags:
      - Consents
      summary: Record Consent
      description: 'Record acceptance of a legal document version and return the entry; call this

        only after showing the user the document URL and version and receiving an

        explicit affirmative answer.


        Without `tenant_id` it records the caller''s own consent; with `tenant_id` it

        records on behalf of that tenant and needs level owner. Idempotent for an

        already-recorded document+version pair, which returns the existing record with

        a 200 instead of creating a duplicate.'
      operationId: record_consent
      security:
      - HTTPBearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConsentIn'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsentOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-destructive: false
      x-idempotent: true
      x-mcp-body-fields:
      - name: document_code
        required: true
      - name: document_version
        required: true
      - name: tenant_id
        required: false
    get:
      tags:
      - Consents
      summary: List Consents
      description: 'Return the caller''s own recorded consents plus the tenant-scope consents of

        every tenant where the caller is at least a viewer. Call this to check which legal

        documents have already been accepted before asking again. Pass `tenant_id` to

        list one tenant''s consents only (a caller of several tenants must).'
      operationId: list_consents
      security:
      - HTTPBearer: []
      parameters:
      - name: tenant_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Tenant Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ConsentOut'
                title: Response List Consents
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ConsentOut:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        subject_sub:
          type: string
          title: Subject Sub
        tenant_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Tenant Id
        document_code:
          type: string
          title: Document Code
        document_version:
          type: string
          title: Document Version
        granted_at:
          type: string
          format: date-time
          title: Granted At
        source:
          type: string
          title: Source
      type: object
      required:
      - id
      - subject_sub
      - document_code
      - document_version
      - granted_at
      - source
      title: ConsentOut
    ConsentIn:
      properties:
        document_code:
          type: string
          title: Document Code
        document_version:
          type: string
          title: Document Version
        tenant_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Tenant Id
          description: Record on behalf of this tenant (needs level owner). Omit to record the caller's own consent.
      type: object
      required:
      - document_code
      - document_version
      title: ConsentIn
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer