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

# Change document retention or lifecycle

> Requires a signed-in workspace member bearer session. API keys are not accepted. Workspace and environment come from the validated session. Changes require the workspace owner or administrator.

Use a valid workspace bearer session. An API key cannot authorize this endpoint. The current workspace and environment are derived from that session.

See [information handling](/enterprise/information-handling) for file limits, versioning, holds, retention and disposal behavior.


## OpenAPI

````yaml mint-openapi.yaml POST /v1/vault/documents/{id}/actions
openapi: 3.0.3
info:
  title: Truthlocks API
  description: >
    Truthlocks is a universal verification infrastructure for documents,
    credentials, and digital assets.

    This specification defines the canonical API for interacting with Truthlocks
    services.


    ## Base URLs

    - **Production**: `https://api.truthlocks.com`

    - **Sandbox**: `https://sandbox-api.truthlocks.com`


    ## Authentication

    - **API Keys**: Use `X-API-Key` header for machine-to-machine operations

    - **Bearer Tokens**: Use `Authorization: Bearer <jwt>` for user-initiated
    operations


    ## Tenant Identity

    In production, tenant identity is derived from the authenticated context
    (API key or JWT).

    The `X-Tenant-ID` header is ignored in production to prevent spoofing.
  version: 1.0.0
  contact:
    name: Truthlocks Support
    url: https://truthlocks.com/support
    email: support@truthlocks.com
servers:
  - url: https://api.truthlocks.com
    description: Production API
  - url: https://sandbox-api.truthlocks.com
    description: Sandbox Environment
security:
  - APIKey: []
  - BearerAuth: []
tags:
  - name: Authentication
    description: API key and token management
  - name: Issuers
    description: Issuer registration and trust management
  - name: Keys
    description: Cryptographic key management for issuers
  - name: Attestations
    description: Attestation lifecycle (mint, revoke, supersede)
  - name: Verification
    description: Attestation verification and proof bundles
  - name: Governance
    description: Issuer governance workflows (admin only)
  - name: Identity
    description: Organization, user, and role management
  - name: Audit
    description: Audit event queries
  - name: Tenant Console
    description: Tenant profile and lifecycle endpoints
  - name: Health
    description: Service health and readiness endpoints
  - name: Risk
    description: Risk signal ingestion and fraud detection
  - name: Risk Enforcement
    description: Risk enforcement actions — block, challenge, quarantine, and configuration
  - name: Billing
    description: Billing, subscription, and addon management
  - name: Machine Identity
    description: >-
      Machine Agent Identity Protocol (MAIP) — agent registration, sessions,
      trust, witness, compliance, orchestration, and observability
externalDocs:
  description: Transparency read-only API (separate service spec)
  url: >-
    https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
  /v1/vault/documents/{id}/actions:
    post:
      tags:
        - Document Vault
      summary: Change document retention or lifecycle
      description: >-
        Requires a signed-in workspace member bearer session. API keys are not
        accepted. Workspace and environment come from the validated session.
        Changes require the workspace owner or administrator.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Document identifier in the current workspace environment.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                action:
                  type: string
                  enum:
                    - archive
                    - restore
                    - retention
                    - purge
                reason:
                  type: string
                  minLength: 10
                  maxLength: 2000
                confirmed:
                  type: boolean
                  enum:
                    - true
                  description: >-
                    Confirm the reviewed action. Purge permanently removes
                    eligible file contents.
                legal_hold:
                  type: boolean
                  description: For retention actions. An active hold blocks purge.
                retain_until:
                  type: string
                  format: date-time
                  nullable: true
                  description: >-
                    For retention actions. Include the existing date when
                    changing a hold. An existing date cannot be shortened or
                    cleared.
              required:
                - action
                - reason
                - confirmed
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - confirmed
        '401':
          description: >-
            The request could not be completed. Read the returned error and
            current document state before retrying.
        '403':
          description: >-
            The request could not be completed. Read the returned error and
            current document state before retrying.
        '404':
          description: >-
            The request could not be completed. Read the returned error and
            current document state before retrying.
        '409':
          description: >-
            The request could not be completed. Read the returned error and
            current document state before retrying.
      security:
        - BearerAuth: []
components:
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for machine-to-machine authentication
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT for user-initiated operations

````

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