ePost Sign

Submit a document for signing and create a signing process.

Submits exactly ONE document to be signed and creates a signing process. Uses <code>multipart/form-data</code> analogous to <code>POST /epost/v2/deliveries</code>: a <code>file</code> part (the PDF) and a <code>metadata</code> JSON part (<code>SigningProcessCreateRequest</code>). The document is stored, a slot per participant is created, and the signature document is made available to each participant in the signing room. Participants without an ePost account receive a forced-onboarding email when <code>forceOnboarding = true</code> AND the credential is an email address (onboarded users can complete only <code>SES</code>). Returns the created process id and its initial status; full details via <code>GET /signing/processes/{processId}</code>. Access requires the ePost Sign widget subscription. Billing a signing to a company requires the <code>DOCUMENT_SIGN_BILLING</code> company role in the KLARA web client role system on the paying company.

post/epost/signing/processes

Request

  • Base URL: https://api.klara.ch
  • URL: https://api.klara.ch/epost/signing/processes
  • Auth: one of:
    • API key in header X-API-KEY
    • HTTP bearer

Headers

Idempotency-Keystring
Example:d3f4c2b1-9a8b-4c8b-8a5f-7c8b9a1e2d34

Client-generated key that prevents duplicate process creation on retries. Optional: if omitted, retries may create a duplicate process. Same key + same payload returns the original result; same key + different payload → HTTP 409.

Response

Signing process accepted and created.

processIdstring uuid

Server-assigned unique identifier of the signing process.

statusobject

Initial lifecycle status of the process.

Example response

{
  "processId": "6c2df3c0-5b1a-4c92-9c46-3b8a9e0e2d51"
}

Changes

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