SDK Partner UI › ARCHIVE

Archive — Retention profiles

/api/archive/retention-profiles. A retention profile says how long a class of documents is kept and how it leaves retention. Each change is its own version: define one, then activate it, retire it when it is superseded, and view any version or list your own. Whether a statutory profile may be published, and whether a version may be defined twice, are the archive's rules — a refusal is shown as it arrives.

Define — POST /retention-profiles
A slug, not a GUID.
Anchor rule
Disposition rule
Duration is for sourced-duration, review authority for explicit-review. The archive checks which one is required.
Proof requirement
External custody requirement
Activate — POST /retention-profiles/{id}/versions/{version}/activate
Retire — POST /retention-profiles/{id}/versions/{version}/retire
List — GET /retention-profiles
Your company's own versions only. The archive applies the filters and judges their values.
View a version — GET /retention-profiles/{id}/versions/{version}