ePost eArchive

Uploads a document to the ePost archive of the authenticated tenant together with its metadata.

Uploads a document to the ePost archive of the authenticated tenant together with its metadata.

The request contains the binary file and document metadata. After a successful upload, the document is stored in the tenant's ePost archive and can be accessed through the archive.

post/epost/v2/archives/upload

Request

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

Response

Document uploaded successfully.

documentIdstring

Identifier of the newly archived document.

fileNamestring

File name of the stored document (post sanitization).

documentTitlestring

Display title of the archived document.

documentReferenceDatestring

Reference date of the document (yyyy-MM-dd).

descriptionstring

Display description of the archived document.<br> Sourced from the BFF response field <code>documentDescription</code> and renamed here to <code>description</code> so the public API uses one consistent term across request and response.

directoryIdsstring[]

Directory ids the document is stored in, as resolved by the eArchive backend (after permission checks and root-directory normalization). Omitted when the document is stored at the root.<br> Sourced from the BFF response field <code>folderIds</code> and renamed here to <code>directoryIds</code> so the public API uses one consistent term across request and response.

createdBystring

User identifier (typically email) that created the document.

createdDatestring

Creation timestamp in ISO-8601 format (UTC).

updatedBystring

User identifier (typically email) of the last update. Equal to <code>createdBy</code> on initial upload.

updatedDatestring

Last update timestamp in ISO-8601 format (UTC). Equal to <code>createdDate</code> on initial upload.

versionNumberinteger

Monotonically increasing version number of the document. Starts at <code>1</code> on initial upload.

Example response

{
  "documentId": "6a028c8e3a805659063bde2f",
  "fileName": "Invoice_2026_05_08.pdf",
  "documentTitle": "Invoice 2026-05-08",
  "documentReferenceDate": "2026-05-08",
  "description": "Monthly partner export for invoicing reconciliation",
  "directoryIds": [
    "637b04533b81694d793c2159"
  ],
  "createdBy": "kiendong2411@axongroupio.ch",
  "createdDate": "2026-05-12T02:12:30.691Z",
  "updatedBy": "kiendong2411@axongroupio.ch",
  "updatedDate": "2026-05-12T02:12:30.691Z",
  "link": {
    "self": "064f1c76-ed3e-4d3d-800b-9195e13edcbe/documents/6a028c8e3a805659063bde2f"
  },
  "versionNumber": 1
}

Changes

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