Skip to navigation

Share Encrypted Text

View as Markdown

Creates a single-use text share from a KNF1 ciphertext that the client encrypted locally. The server never receives the text or the key. Up to 10 KB of plaintext per share.

Authentication

AuthorizationBearer

Konfidant API key (kf_live_... or kf_test_...), created by an organization admin in the dashboard.

Request

This endpoint expects an object.
ciphertextstringRequiredformat: "byte"

Standard (padded) base64 encoding of the KNF1 ciphertext (kind = text).

ttl_hoursintegerOptional>=1

Lifetime of the share link in hours. Optional; defaults to the maximum allowed by the organization’s plan. Values above the plan maximum are rejected with 400.

Response

Created
download_urlstringformat: "uri"

Single-use download URL with the server-issued token in the fragment (#t=...). It does not open the share by itself: append &k=<base64url key> to build the share link you send to the recipient.

text_idstring or null

Share ID; null unless verified burn is enabled.

expires_atdatetime

When the share link expires (ISO 8601).

verified_burnboolean
Whether the organization has verified burn enabled. When false, no share record is stored and the ID is null.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
502
Bad Gateway Error