ePost Sign

Get a signing process — submitted data plus current signing status.

Returns the data submitted on <code>POST</code> plus the signing status: who has already signed and who has not. The name shown is the one used within the signing process / signature itself — per CISO, no additional profile data is resolved from ePost. Deliberately NOT returned: the full <code>unhashedCredentials</code> (personal-data protection) and the document payload (use <code>GET /signing/processes/{processId}/document</code>).

get/epost/signing/processes/{processId}

Request

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

Path parameters

processIdstring uuid required
Example:6c2df3c0-5b1a-4c92-9c46-3b8a9e0e2d51

Server-assigned unique identifier of the signing process.

Response

Current state of the signing process.

processIdstring uuid

Unique identifier of the signing process.

titlestring

Title of the signing request.

descriptionstring nullable

Optional description.

signatureTypeobject

Chosen signature type. Locked at creation.

modeobject

Signing order strategy. Locked at creation.

deadlinestring date

Signing deadline (ISO 8601).

forceOnboardingboolean

Whether forced onboarding was requested for unresolved email participants.

statusobject

Current lifecycle status.

deliveryStateobject

Delivery/orchestration state of the process side effects (independent of <code>status</code>). Non-terminal values are retryable via <code>POST /signing/processes/{processId}/retry-delivery</code>.

signedCountinteger

Number of participants that have already signed.

pendingCountinteger

Number of participants still outstanding (<code>PENDING</code> / <code>FORCED_ONBOARDING</code>).

createdAtstring date-time

Creation timestamp (ISO 8601).

completedAtstring date-time nullable

Timestamp at which every required signature was collected. <code>null</code> while incomplete.

deleteAtstring date-time nullable

When the process/document will be finally deleted. Retention per CISO: open + signed documents 90 days; cancelled/deactivated processes 30 days; audit/process metadata 12 months.

Example response

{
  "processId": "6c2df3c0-5b1a-4c92-9c46-3b8a9e0e2d51",
  "title": "Rental contract Bahnhofstrasse 12",
  "description": "Please sign by the end of the month.",
  "submittedBy": {
    "pid": "c60d31fa-f335-4957-872a-90b035632081",
    "name": "Anna Muster"
  },
  "deadline": "2026-12-31",
  "forceOnboarding": true,
  "signedCount": 1,
  "pendingCount": 2,
  "participants": [
    {
      "internalTrackingId": "b4a9b3f1-c8d0-4e2a-b5f6-b7c8d9e0a1b2",
      "participantId": "c60d31fa-f335-4957-872a-90b035632081",
      "name": "Anna Muster",
      "roles": [
        "SIGNER",
        "RECEIVER"
      ],
      "hashedPrimaryValue": "5f4dcc3b5aa765d61d8327deb882cf99",
      "signedByUserEmail": "anna.muster@example.ch",
      "effectiveSignerUserEmail": "delegate@example.ch",
      "sequenceIndex": 1,
      "rejectedReason": "Wrong recipient",
      "signedAt": "2026-09-01T14:22:07Z"
    }
  ],
  "document": {
    "fileName": "rental-contract.pdf",
    "contentType": "application/pdf",
    "sizeBytes": 154382,
    "currentVersion": 2
  },
  "createdAt": "2026-08-13T09:15:30Z",
  "completedAt": "2026-09-05T11:03:19Z",
  "deleteAt": "2026-12-04T09:15:30Z"
}

Changes

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