---
title: "Checking matching process."
method: GET
path: "/epost/v2/matching-runs/processing/{matching-run-id}"
tags: ["ePost Digital LetterBox Identity Matching with detailed recipient feedback"]
---

# Checking matching process.

`GET /epost/v2/matching-runs/processing/{matching-run-id}`

## Request

- Base URL: `https://api.klara.ch`
- URL: `https://api.klara.ch/epost/v2/matching-runs/processing/{matching-run-id}`
- Auth: one of:
  - API key in header `X-API-KEY`
  - HTTP bearer

## Path parameters

- `matching-run-id` string, required

## Response `200`

Matching process is processing.

- MatchingRunProcessResponse
  - `status` 'PROCESSING' | 'FINISHED'
  - `matchingResult` MatchingResponse
    - `matchedRecipients` MatchedRecipient[]: This list contain the recipient info which matched with given information.
      - `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.
      - `senderUserId` string: This id is for the sender to recognize the recipient.
      - `levelOfTrust` '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.
      - `notMatchCredentials` string[]: The list credentials not matched.
      - `errorMessage` string: The error message of matching services (if any)
      - `communityId` string: The recipient's community ID (Matrix ID) for individual tenants active in the ePost community. Omitted when the recipient is not an individual or has no community account.
    - `nonMatchedRecipients` MatchedRecipient[]: This list contain the non-matched recipient with the error message corresponding.
      - `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.
      - `senderUserId` string: This id is for the sender to recognize the recipient.
      - `levelOfTrust` '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.
      - `notMatchCredentials` string[]: The list credentials not matched.
      - `errorMessage` string: The error message of matching services (if any)
      - `communityId` string: The recipient's community ID (Matrix ID) for individual tenants active in the ePost community. Omitted when the recipient is not an individual or has no community account.

## Other responses

- `303`: Finished matching process. Then auto redirect to get matching result api /matching-runs/{matching-run-id} and return matching result.
- `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.
- `404`: Resource not found<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.
- `429`: API rate limit exceeded<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)