Create download grants

Purpose returns short-lived authorized download.

POST/api/v1/tenant/documents/{id}/download-grants

Authorization

Use a server-side API key with the listed grants and permitted resource access.

documents:read

Request headers

X-Api-Keyrequired: Your server-side integration credential.
Idempotency-Keyrequired: Stable key for this intended action. Reuse it for retries of the same request.

Path parameters

idstring · required: Opaque identifier in the authorized resource scope. Nested identifiers must belong to their parent resource.

Response

201Created

Returns the authorized resource or result for this operation. List results use items, nextCursor, and hasMore.

Behavior to account for

Only authorized, released content can be downloaded. Grant URLs expire and must not be stored as permanent file locations.

Errors

Authentication failures return 401 or 403. Inaccessible resources return 404. Business and idempotency conflicts return 409. Rate limits return 429 with retry guidance.

Error handling guide

REQUESTAPI key

curl --request POST 'https://api.wincora.com/api/v1/tenant/documents/id_example/download-grants' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Idempotency-Key: request-example-001'

const response = await fetch('https://api.wincora.com/api/v1/tenant/documents/id_example/download-grants', {
  method: 'POST',
  headers: {
    "X-Api-Key": process.env.WINCORA_API_KEY,
    "Idempotency-Key": "request-example-001"
  }
});

if (!response.ok) throw new Error(await response.text());
const result = await response.json();

import os
import requests

response = requests.request(
    'POST',
    'https://api.wincora.com/api/v1/tenant/documents/id_example/download-grants',
    headers={
      "X-Api-Key": os.environ["WINCORA_API_KEY"],
      "Idempotency-Key": "request-example-001"
    },
    timeout=30,
)
response.raise_for_status()
result = response.json()

Keep this API key on your server. Never embed it in browser or mobile code.