DKBSignDocs

API reference

POSTRequires Bearer token

Set or clear legal hold

/api/edm/documents/{document_id}/legal-hold

Company-admin / manage right. Held documents are not purged.

Path parameters

FieldTypeDescription
document_id
Required
stringPath parameter document_id.

Query parameters

This endpoint has no query parameters.

Request body

FieldTypeDescription
hold
Required
booleanSet (true) or clear (false) legal hold.
e.g. true

Responses

StatusMeaning
200Legal hold updated
401Missing or invalid Bearer token.

Request

curl
curl -X POST 'https://api.dkbsigns.com/api/edm/documents/uuid_or_id/legal-hold' \
  -H 'Authorization: Bearer $DKBSIGN_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"hold":true}'

Response 200

json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "org_id": "1",
  "folder_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "typology_id": null,
  "name": "Contract 2026.pdf",
  "status": "draft",
  "size_bytes": 1048576,
  "mime_type": "application/pdf",
  "owner_user_id": "4",
  "metadata": {},
  "tags": [
    "client-x"
  ],
  "legal_hold": true,
  "version_count": 1,
  "sealed_at": null,
  "created_at": "2026-03-01T10:00:00Z",
  "updated_at": "2026-03-01T10:00:00Z"
}