Document AI — DMS

Compliance: Activate WORM (300 Credits)

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.

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

Request body

pofidstring required

PaperOffice document ID (POFID).

document_type_idinteger

Optional document type ID (overrides the workspace default).

anchor_mode'immediate' | 'document_date'

Retention anchor: immediate (upload time) or document_date (document date).

Response

Success

status'success' | 'error'
pofidstring
is_revision_secureboolean
retention_untilstring date-time
retention_mode'governance' | 'compliance'
retention_legal_basisstring

Changes

No recorded changes to this operation across all 1 revision of this API.