DKBSignDocs

API reference

POSTRequires Bearer token

Create a document share

/api/edm/documents/{document_id}/shares

Returns token once (32-byte url-safe; only the SHA-256 is stored) and url (/shared/{token}). Recipients open GET /api/edm/shared/{token}. TTL is clamped to share_max_ttl_hours (default 72h).

Path parameters

FieldTypeDescription
document_id
Required
stringPath parameter document_id.

Query parameters

This endpoint has no query parameters.

Request body

FieldTypeDescription
scope
stringinternal (default) or external.
e.g. "external"
expires_in_hours
integerLink TTL in hours.
e.g. 48
max_uses
integerOptional use cap.
e.g. 10
password
stringOptional password (PBKDF2).

Responses

StatusMeaning
201Token shown once
401Missing or invalid Bearer token.

Request

curl
curl -X POST 'https://api.dkbsigns.com/api/edm/documents/uuid_or_id/shares' \
  -H 'Authorization: Bearer $DKBSIGN_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"scope":"external","expires_in_hours":48,"max_uses":10,"password":"P@ssw0rd!"}'

Response 201

json
{
  "id": "share-1",
  "token": "xY9…",
  "url": "/shared/xY9…",
  "scope": "external",
  "expires_in_hours": 48
}