ePost Digital LetterBox Identity Matching with detailed recipient feedback

Identity matching process.

Send metadata of your customers for matching them with ePost users. There is the possibility to hash the metadata before sending it. It isn't mandatory to send all data for identity matching, but the sent data has to be unique in it's combination.<br><br>The access to this API request is restricted, because it returns detailed information about whether a credential has been matched or not. Against a fee you are able to use this detailed identity matching API. Please get in touch with an administrator to get more information.

post/epost/v2/matching-runs

Request

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

Request body

Example request

{
  "recipients": [
    {
      "hashedPrimaryCredential": "email",
      "hashedPrimaryValue": "adu7adsfnn3489asdfn334jk",
      "derivedHashedValue": "adu7adsfnn3489asdfn334jk",
      "unhashedCredentials": {
        "universalName": "KLARA Business AG / Peter Muster",
        "firstName": "Peter",
        "lastName": "Muster",
        "companyName": "KLARA",
        "companyUid": "CHE-123.456.789",
        "street": "Bahnhofstrasse 10a",
        "streetNumber": "20",
        "zipCode": "3000",
        "city": "Bern",
        "email": "peter.muster@gmail.com",
        "mobileNumber": " +41909112233",
        "birthDate": "1990-01-02",
        "socialSecurityNumber": "756.1234.5678.97",
        "taxId": "263125",
        "postOfficeBoxNumber": "12",
        "postOfficeBoxZip": "1212",
        "postOfficeBoxTownName": "Vervey 1",
        "unstructuredAddressLine01": "Peter Muster",
        "unstructuredAddressLine02": "Bahnhofsstr 20",
        "unstructuredAddressLine03": "8004 Zurich Switzerland",
        "billRecipientId": "41010560425610173"
      }
    }
  ]
}

Response

Request accepted

matchingRunResultLocationstring

Contains the URL location to get the matching run result

Changes

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