Files

Store a document once for reuse across signings

Returns a fileToken a later signing may reference instead of carrying base64 again. Multipart accepts one binary part named file, up to 100,000,000 bytes; JSON accepts up to 15 MiB decoded. Format validation is identical for both transports. Office files and images are converted to PDF/A-2b on upload (v1.9.0), so the stored file and its name are the PDF.

The bytes are copied into each signing that uses the token, never shared by reference: deleting a file, or letting it expire, can never reach backwards into a signing that already used it.

post/v1/files

Request

  • Base URL: https://sign-api.tvarka.pro
  • URL: https://sign-api.tvarka.pro/v1/files
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key
    • OAuth 2 (authorization code, authorization URL https://sign-api.tvarka.pro/oauth/authorize, token URL https://sign-api.tvarka.pro/oauth/token, scopes: sign.read, sign.signings)

Request body

namestring required
contentstring byte required

Response

The stored file.

fileTokenstring uuid
namestring
mediaTypestring
sha256string
bytesinteger
createdAtstring date-time
expiresAtstring date-time

An unreferenced upload is not kept forever just because nobody deleted it. Re-upload after this, or post the bytes inline.

usedCountinteger

How many signings have copied these bytes.

Changes

No recorded changes to this operation across all 1 revision of this API.