Standard ePost Digital Letterbox Identity Matching

Identity matching process. Standard version just return the user's basic information.

Send metadata of your customers for matching them with ePost users. The limit size of the metadata is 5 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.

post/epost/v2/standard-matchings

Request

  • Base URL: https://api.klara.ch
  • URL: https://api.klara.ch/epost/v2/standard-matchings
  • 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

Get matched users

nonMatchedSenderUserIdsstring[]

This list contain the non-matched recipient.

Changes