---
title: "Improves users's onboarding experience and add credentials"
method: POST
path: "/epost/onboarding"
tags: ["ePost Digital Letterbox Onboarding and Profile Management"]
---

# Improves users's onboarding experience and add credentials

`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

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.

## Query parameters

- `encrypt-token` boolean

## Request body

- Onboarding: This model to hold data for onboarding steps
  - `pinBrandedFolder` boolean
  - `addingCredential` object: Credentials to be add to user account, who scan the qr code.
    - `othercredentials` QrCodeCredential[]: List of credentials to be add to user account, who scan the qr code.
      - `name` 'MOBILE' | 'TAX_ID' | 'EMAIL', required: Name of an qr code credential. Valid values: MOBILE, TAX_ID, EMAIL
      - `value` string, required: Value of an qr code credential.
      - `verificationScore` integer: Verification score
    - `address` object: Address to be add to user account, who scan the qr code.
      - `type` 'PO_BOX' | 'POSTAL', required: Type of an qr code address. Valid values: PO_BOX, POSTAL
      - `firstName` string, required: First name of an address.
      - `lastName` string, required: Last name of an address.
      - `street` string: Street name of an address.
      - `streetNumber` string: Street number of an address.
      - `zipCode` string: Zip code of an address.
      - `city` string: City code of an address.
      - `additionalAddressLine` string: Additional to an address.
      - `postOfficeBoxNumber` string: Post office box number
      - `postOfficeBoxZip` string: Post office box zipcode
      - `postOfficeBoxTownName` string: Post office box town name
      - `verificationScore` integer: Verification score
      - `gender` string: Gender of address's owner. Allow values: "male", "female"

## Response `201`

QR code or Link generated successfully.

## Other responses

- `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.
- `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.
- `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)