Documents

Get a download URL

GET/documents/{documentId}/download

Returns a 1-hour presigned URL and writes a download access record. Unreadable: 404. status not file_available: 409 invalid_state. allow_download false, or null on a PDF the organisation blocks: 403 missing_permission unless you manage documents. PDFs the organisation watermarks for the caller, or masks, are served as a temporary copy, reused that day per user, settings and timezone. 409 conflict if the original is over 20 MB, password-protected, a signed copy with no cached page offset, or can't be transformed. No webhook; can't be undone.

Path parameters

  • documentIdstring (uuid)Required#

    The document's public uuid.

Query parameters

  • timezonestring#

    IANA timezone name for the date printed on a watermark, such as Europe/London. An unknown name falls back to UTC. At most 64 characters.

Responses

200

OK

{
  "url": "https://files.example-cdn.com/documents/5e6f7081-92a3-4b4c-9d6e-7f8091a2b3c4?signature=abc123&expires=1781000000",
  "expires_at": "2026-06-15T11:30:00Z"
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
409

The request conflicts with existing state (error.code = conflict), e.g. a compliance flow with the requested name already exists.

Error
422

Request validation failed (HTTP 422). The body is either the Laravel validation envelope (message + field-keyed errors) or the API error envelope for domain rejections (e.g. form_type_not_supported, folder_locked, parent_not_found, folder_not_empty).

429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/documents/{documentId}/download\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"