---
title: "Compliance: Activate WORM (300 Credits)"
method: POST
path: "/documents/document-retention-activate"
tags: ["Document AI — DMS"]
---

# Compliance: Activate WORM (300 Credits)

`POST /documents/document-retention-activate`

## Request

- Base URL: `https://api.paperoffice.ai/latest`
- URL: `https://api.paperoffice.ai/latest/documents/document-retention-activate`
- Auth: HTTP bearer

Activates WORM protection (write-once-read-many) for a document. The document becomes immutable for the configured retention period (retention_years); deletion is only possible after expiry.

## Request body

- object
  - `pofid` string, required: PaperOffice document ID (POFID).
  - `document_type_id` integer: Optional document type ID (overrides the workspace default).
  - `anchor_mode` 'immediate' | 'document_date': Retention anchor: `immediate` (upload time) or `document_date` (document date).

## Response `200`

Success

- object
  - `status` 'success' | 'error'
  - `pofid` string
  - `is_revision_secure` boolean
  - `retention_until` string, date-time
  - `retention_mode` 'governance' | 'compliance'
  - `retention_legal_basis` string

## Other responses

- `4XX`: Error
- `5XX`: Error

---

[API](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api.md) · [All operations](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/revisions/c6a6228a4509?raw)