ePost Digital Letterbox Onboarding and Profile Management

Improves users's onboarding experience and add credentials

Generate a link or QR code on which interacted/scanned, the actions defined in the request body will be executed.<br/>The response output is decided by the <b>Accept</b> header of the request<br/>If a value of "text/html" is entered in the <b>Accept</b> header, a response with "text/html" media type is returned containing the URL.<br/>If a value of "image/png" is entered in the <b>Accept</b> header, a response with "image/png" media type is returned containing the QR code.<br/><b>Verification score</b> of the credentials <b>Accept</b> value 0 or 50.<br/>Only one credential has <b>verification score</b> in the request body.

post/epost/onboarding

Request

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

Query parameters

encrypt-tokenboolean

Indicate that if the encryption is required for the token part of the response URL.<br/>Should be true when the token payload contains recipient's credentials.

Request body

pinBrandedFolderboolean

Example request

{
  "addingCredential": {
    "othercredentials": [
      {
        "name": "EMAIL",
        "value": "peter.muster@gmail.com"
      }
    ],
    "address": {
      "type": "POSTAL",
      "firstName": "Peter",
      "lastName": "Muster",
      "street": "Bahnhofstrasse",
      "streetNumber": "20",
      "zipCode": "3000",
      "city": "Bern",
      "additionalAddressLine": "additional address info",
      "postOfficeBoxNumber": "12",
      "postOfficeBoxZip": "1212",
      "postOfficeBoxTownName": "Vervey 1",
      "verificationScore": 50,
      "gender": "male"
    }
  }
}

Response

QR code or Link generated successfully.

Changes

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