---
title: "Get monitoring data for the deliveries."
method: GET
path: "/epost/deliveries/monitoring"
tags: ["ePost Communication Platform Monitoring"]
---

# Get monitoring data for the deliveries.

`GET /epost/deliveries/monitoring`

## Request

- Base URL: `https://api.klara.ch`
- URL: `https://api.klara.ch/epost/deliveries/monitoring`
- Auth: one of:
  - API key in header `X-API-KEY`
  - HTTP bearer

## Query parameters

- `delivery-id` integer
- `limit` integer
- `offset` integer
- `sort` 'DESCENDING' | 'ASCENDING'

## Response `200`

List of recipient tracking was returned

- RecipientTrackingDataResponse[]
  - `id` integer
  - `deliveryId` integer
  - `deliveredTime` string, date-time
  - `createdTime` string, date-time
  - `costCenter` string
  - `documentTitle` string
  - `documentTypes` DocumentType[]
  - `unhashedCredentials` UnhashedCredential: Full participant credentials — submission only. Never returned by <code>GET</code> endpoints. Reuses the shared <code>UnhashedCredential</code> DTO used elsewhere in the public API (e.g. ePost deliveries).
    - `universalName` string: If you are not sure whether the recipient is a company or a person, then this field can be used to put the name of the recipient
    - `firstName` string: First name of a recipient.
    - `lastName` string: Last name of a recipient.
    - `companyName` string: If the tenant entry is a business customer, i.e a Company, enter the company name here.
    - `companyUid` string: If the tenant entry is a business customer, i.e a Company, enter the company UID here.<br/>In case you are inputting the company UID for delivery via eBill channel to a company recipient, pay attention to not input any value for the billRecipientId. Otherwise, delivery is only possible if both values are correct for the recipient of eBill.
    - `street` string: Street name in the address of a recipient.<br/>As an option, street name and street number can be added here together in this field. In that case, leave the "streetNumber" field empty.
    - `streetNumber` string: Street number in the address of a recipient.
    - `zipCode` string: Zip code in the address of a recipient.
    - `city` string: City in the address of a recipient.
    - `email` string: Email of a recipient.<br/>In case you are inputting the email of the recipient for delivery via eBill channel, pay attention to not input any value for the billRecipientId. Otherwise, delivery is only possible if both values are correct for the recipient of eBill.
    - `mobileNumber` string: Mobile number of the recipient.<br/>Must be a valid international phone number: Beginning with a '+' sign followed by a 1-3 digit country code and the domestic phone number.
    - `birthDate` string, date: Birth date of a recipient in ISO 8601 format (yyyy-mm-dd)
    - `participantId` string: This field is result of identity matching process, if value is entered in request then it will have highest priority for matching search process.
    - `clientLegacyId` string: This id is optional and is used to support legacy systems.
    - `minimumLevelOfTrust` 'BRONZE' | 'SILVER' | 'GOLD': The Levels of Trust (LoT) define how strong a user is verified in the KLARA ecosystem. Three possible level of trust: BRONZE, SILVER, GOLD.
    - `socialSecurityNumber` string: Social security number of a recipient and must be unique.
    - `taxId` string: Tax ID of a recipient and must be unique.
    - `postOfficeBoxNumber` string: Post office box number
    - `postOfficeBoxZip` string: Post office box zipcode
    - `postOfficeBoxTownName` string: Post office box town name
    - `unstructuredAddressLine01` string: If you are not sure which part of the address is name, street, house number, city or postcode, then you can input your address in the unstructured line 1 to 3. Keep in mind that sending unstructured addresses will result to a lower matching rate
    - `unstructuredAddressLine02` string: If you are not sure which part of the address is name, street, house number, city or postcode, then you can input your address in the unstructured line 1 to 3. Keep in mind that sending unstructured addresses will result to a lower matching rate
    - `unstructuredAddressLine03` string: If your unstructured address has more than 3 lines, input all the remaining in this line. Keep in mind that sending unstructured addresses will result to a lower matching rate
    - `billRecipientId` string: Bill recipient Id from eBill. Using in eBill channel only.<br/>In order to deliver via eBill channel, you can input this credential. If you input more than 1 credential for eBill, delivery can happen only if all of these credentials are found in the recipient of eBill by SIX.
  - `senderUserId` string
  - `cost` number
  - `channel` string
  - `status` string
  - `thirdPartyStatus` string
  - `thirdPartyErrorMessage` string
  - `errorCode` string
  - `deliveryChannelPreferences` DeliveryChannelPreference[]
  - `detail` DetailInfo
    - `documentMetadata` DocumentMetadataWithoutRecipients
      - `allCredentialShouldMatch` boolean
      - `fileName` string
      - `mediaType` string
      - `senderName` string
      - `senderEndToEndId` string
      - `senderCaseId` string
      - `documentReferenceDate` string, date
      - `documentTitle` string
      - `documentTypes` string[]
      - `allRecipientsRequired` boolean
      - `origin` string
      - `documentMessage` string
      - `ebillAdditionalInfo` EbillAdditionalInfo: Group of the eBill delivery information.
        - `dueDate` string, date: Due date of business case
        - `paymentAmount` number: Amount to be paid for the invoice document
        - `qrReference` string: Reference number in the invoice document, this field is referring to the QR Reference, as the biller should have provided a QR-IBAN.
      - `emailAdditionalInfo` EmailAdditionalInfo: Group of the email delivery information.
        - `emailText` string: Content of the email.
        - `emailHtml` string: Content of the email in html format.
        - `emailSubject` string: Subject of the email.
        - `sender` object: The sender's email info (only used for sending in EMAIL channel)
          - `email` string: Email address
          - `name` string: Name of email
        - `replyTo` AdditionalEmailInfo[]: Reply to the given emails.
          - `email` string: Email address
          - `name` string: Name of email
        - `cc` AdditionalEmailInfo[]: Sending email as cc list.
          - `email` string: Email address
          - `name` string: Name of email
        - `bcc` AdditionalEmailInfo[]: Sending email as bcc list.
          - `email` string: Email address
          - `name` string: Name of email
        - `inlineImages` EmailInlineImage[]: Inline images of the email
          - `filename` string, required: filename of the inline image
          - `base64` string, required: file content of the inline image as base64.
      - `physicalAdditionalInfo` PhysicalAdditionalInfo1
        - `postage` 'A_POST' | 'B_POST' | 'B_POST_LARGEVOLUME' | 'A_PLUS' | 'REGISTERED'
        - `envelopeSize` 'C4' | 'C5' | 'BOX' | 'AUTO'
        - `duplex` boolean
        - `windowLocation` 'LEFT' | 'RIGHT'
        - `qrInvoicePageNumber` integer
        - `shippingCountry` string
      - `digitalAdditionalInfo` DigitalAdditionalInfo: Group of the digital delivery information.
        - `digitalDeliveryVariant` 'STANDARD' | 'NO_CONFIRMATION' | 'TRACKED' | 'REGISTERED': Specifies the tier for the delivery via channel DIGITAL. This selection determines the availability of digital receipts, tracking capabilities, and recipient identification requirements. If digitalDeliveryVariant is omitted, the system defaults to 'STANDARD'.<br/><br/><b>STANDARD</b>: Standard digital delivery with proof of dispatch. Includes a digital timestamp and signature upon acceptance by ePost. [ePost Standard]<br/><b>NO_CONFIRMATION</b>: Basic digital delivery. Provides a digital delivery without additional digital receipts or tracking features. [ePost Light]<br/><b>TRACKED</b>: Enhanced delivery with retrieval tracking. Includes all features of STANDARD, plus 'Retrieval' and 'Non-retrieval' receipts to track if and when the recipient opened the message. [ePost Plus]<br/><b>REGISTERED</b>: Full legal-grade digital registered mail. Includes all TRACKED features, as well as recipient acceptance/rejection tracking and mandatory Person Identification. Important note: 'minimumLevelOfTrust' must be set to GOLD for the recipient, as verification of the recipient as a person by an online identification process is prerequisite for ePost Registered. [ePost Registered]
        - `letterAnswer` string: Specifies an optional recipient response option for the delivery via channel DIGITAL. When set to a supported value, the recipient is offered a corresponding action on the delivered document in the digital letterbox. This field is only considered for the DIGITAL channel; it is ignored for all other channels. Supported values are provisioned per agreement with ePost. If omitted, empty, or set to an unrecognised value, no response option is offered and the delivery proceeds normally.
        - `iLetter` object: iLetter reference parameters for the delivery via channel DIGITAL. Required when this file's mediaType is "application/vnd.ch.klara.epost.v1+iletter"; ignored on every other document (including when mediaType is omitted).
          - `templateId` string, required: Id of the iLetter Template used to create the iLetter to send. Required for every iLetter document sent through this API. Applies only to iLetter documents; ignored on other document types.
          - `batchId` string: Optional correlation key grouping several deliveries onto one iLetter record: sending the same batchId again appends the new recipients to the existing iLetter instead of creating a new one. If omitted, this delivery always creates its own new iLetter, and a resend of a failed delivery updates that same iLetter rather than creating a second one.
          - `confidentialResponses` boolean: Whether the iLetter collects confidential responses: answers are not shown to the sender together with who gave them. Defaults to not confidential when absent.
          - `responseDeadline` string: Date and time by which recipients are asked to answer, as an ISO-8601 instant with UTC offset, for example 2026-10-31T21:59:59Z. Passed on exactly as supplied. Absent means no deadline.
          - `parameters` ILetterParameter[]: Default values for this document's iLetter URL parameters, appended to the letter's data-source calls; one entry per key, at most 20 entries. A recipient may override individual keys under recipients[].iLetter.parameters; per key the recipient's value applies when supplied, otherwise this document-level value. A recipient left without a value for a required key fails with ILETTER_PARAMETER_REQUIRED_VALUE_MISSING naming the key; a key the Template does not declare fails with ILETTER_PARAMETER_KEY_UNKNOWN.
            - `key` string, required: Must match a SENDER_PARAMETER key declared on the iLetter's data sources. At most 64 characters; starts with a letter or underscore, followed by letters, digits, underscores or hyphens.
            - `value` string: The value substituted for this key when the recipient's iLetter resolves the data source. At most 128 characters.
          - `placeholders` ILetterPlaceholder[]: Values for the letter's text placeholders, substituted into the letter text; one entry per key, applied to every recipient of this document. A recipient may override individual keys under recipients[].iLetter.placeholders; per key the recipient's value applies when supplied, otherwise this value. At most 100 entries per level, values of at most 2000 characters; a document over these limits is rejected with ILETTER_PLACEHOLDER_LIMIT_EXCEEDED. A value for a key the letter does not define is ignored. Unlike a missing URL parameter, a recipient left without a value for a required placeholder does not reject the request: that recipient ends in a failed status with ILETTER_PLACEHOLDER_REQUIRED_VALUE_MISSING naming the key, and the other recipients are delivered.
            - `key` string, required: Key of a placeholder defined on the letter. At most 64 characters; starts with a letter or underscore, followed by letters, digits, underscores or hyphens. A key the letter does not define is ignored.
            - `value` string: Text shown to the recipient in place of the placeholder. Any characters, including line breaks; at most 2000 characters.
        - `documentInfoByLanguage` object: Optional localised overwrite of the top-level documentTitle and documentDescription, keyed by uppercase language code (DE, FR, IT, EN). A recipient whose letterbox language has an entry is shown that entry's title and description instead of the top-level values; a recipient whose language has no entry is shown the top-level documentTitle and documentDescription. Relevant only for the DIGITAL channel.
    - `matchedParticipantId` string
    - `deliveryStatus` string
    - `documentStatus` string
    - `documentErrorCode` string
    - `recipientStatus` string
    - `recipientErrorCode` string
    - `pricingList` DetailPricing[]
      - `productCode` string
      - `productName` string
      - `price` number
  - `pricePlan` string
  - `businessStatusHistory` BusinessStatusHistory[]: The history of business status changes for this delivery, ordered from the oldest to the most recent status change.
    - `businessStatus` 'RECEIVED' | 'WAIT_FOR_GROUP' | 'WAIT_FOR_CONFIRMATION' | 'CANCELLED_BY_SENDER' | 'ACCEPTED' | 'FAILURE' | 'DELIVERED' | 'REJECTED_BY_RECIPIENT' | 'ACCEPTED_BY_RECIPIENT' | 'CALLED_BY_RECIPIENT' | 'NOT_CALLED_BY_RECIPIENT' | 'UNDELIVERABLE': The business status of the delivery at this point in history.
    - `changedAt` string, date-time: The UTC timestamp when the business status changed.
    - `triggeredByUserFirstName` string: The first name of the user who triggered the status change.
    - `triggeredByUserLastName` string: The last name of the user who triggered the status change.
  - `effectiveILetterParameters` EffectiveILetterParameter[]: The iLetter parameter key-value pairs actually used for this recipient: the recipient's own override where the sender supplied one, the document's value otherwise. Absent when the delivery carried no iLetter parameters.
    - `key` string: The parameter key.
    - `value` string: The value used for this key for this recipient.
  - `effectiveILetterPlaceholders` EffectiveILetterPlaceholder[]: The iLetter placeholder key-value pairs supplied for this recipient: the recipient's own value where the sender supplied one, the document's value otherwise. Absent when the delivery carried no iLetter placeholders.
    - `key` string: The placeholder key.
    - `value` string: The value supplied for this placeholder for this recipient.

## Other responses

- `400`: Data invalid<br/><br/>Failures detected by a downstream service carry that service's own <code>code</code>, which this reference does not enumerate, so the <code>code</code> field may hold a value not documented here. Treat an unrecognised code as a generic failure of the status it arrives with, and do not branch on a code this reference does not list.
- `401`: No Authorization header found or invalid token<br/><br/>Failures detected by a downstream service carry that service's own <code>code</code>, which this reference does not enumerate, so the <code>code</code> field may hold a value not documented here. Treat an unrecognised code as a generic failure of the status it arrives with, and do not branch on a code this reference does not list.
- `403`: The current user is not allowed to access this company data<br/><br/>Failures detected by a downstream service carry that service's own <code>code</code>, which this reference does not enumerate, so the <code>code</code> field may hold a value not documented here. Treat an unrecognised code as a generic failure of the status it arrives with, and do not branch on a code this reference does not list.
- `500`: Something went wrong on our side while processing the request. Please kindly contact our support.<br/><br/>Failures detected by a downstream service carry that service's own <code>code</code>, which this reference does not enumerate, so the <code>code</code> field may hold a value not documented here. Treat an unrecognised code as a generic failure of the status it arrives with, and do not branch on a code this reference does not list.

---

[API](https://skmtc.dev/klara/apis/klara-public-api.md) · [All operations](https://skmtc.dev/klara/apis/klara-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/klara/apis/klara-public-api/revisions/490b1a879fc2?raw)