Batches

Raise one signing per document for one set of parties

Batch operations group documents for coordinated creation and status tracking, with one API call and one batch identifier. Each document follows its own signing ceremony and receives its own signature. Signers complete the authentication and signing steps for each document.

Creation is atomic: either every signing in the batch is raised, or the error response means none was. Combined source bytes and combined prepared bytes each have a 100,000,000-byte limit, including repeated uses of the same file token. Known oversized inputs are refused before stored-file reads; remote downloads and stored-file reads use the remaining byte allowance. Aggregate overflow returns 413. A remote-download refusal returns 400 with the document URL pointer. Flattening complexity and its cooperative processing budget are shared across all batch documents.

post/v1/batches

Request

  • Base URL: https://sign-api.tvarka.pro
  • URL: https://sign-api.tvarka.pro/v1/batches
  • 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)

Headers

Idempotency-Keystring

Optional tenant-and-operation-scoped create key (1-128 visible ASCII characters). Identical input replays the original response; changed input or an unresolved execution returns 409. After 90 days the response expires but the key remains reserved. Do not change keys to retry a request with an uncertain outcome.

Request body

titlestring required
delivery'link' | 'email'
signingOrder'parallel' | 'sequential'
returnUrlstring uri

Exact registered HTTPS return URL; requires returnState. Qualified signatures only.

returnStatestring
webhookUrlstring uri
externalIdstring
expiresInDaysinteger
softDeadlineInDaysinteger

Applied to every signing the batch raises.

Response

The batch and every signing it raised.

batchIdstring uuid
titlestring
externalIdstring nullable
createdAtstring date-time

Changes

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