Legal onboarding

With Kivra’s legal API, your company can self-onboard other senders to Kivra, within the boundaries of your own software or interface. Here’s how it works.

What is the legal API?

In a nutshell, Kivra’s legal API can make sure that a company or tenant is compliant with legal requirements when sending content in Kivra. It makes it possible for your company to self-onboard other senders to Kivra, within the boundaries of your own software or interface.

Who is the legal API for?

The legal API might be suitable if:

  • Your company offers self-onboarding of other senders within Kivra, and this happens frequently.
  • Your product has an automated, clear, and predictable customer journey within the frames of your own software or interface.

Typically, the legal API is suitable for companies that supply software for accounting, payslips, invoicing, and similar.

Who is the legal API not for?

The legal API is probably not suitable if:

  • Your company doesn’t offer self-onboarding of other senders within Kivra, or if this only happens once in a while.
  • Your product’s onboarding and customer journeys are manual rather than automated.

Typically, a company who doesn’t use the legal API will instead sign manual agreements, where the legal aspects are taken into account.

Interested in the legal API?

Send an email to avsandare.support@kivra.com and we’ll get back to you.


Setting up the legal API

Step 1 – register as a developer

Send an email to avsandare.support@kivra.com with the following information:

  • Name of your company
  • Company registration number
  • Contact person (email address and telephone number)
  • Your request for access to the legal API

Within 1 workday, we will send you everything you need to proceed to step 2.

Step 2 – set up the test environment

Your journey in Kivra’s legal API starts in the test environment. These are the steps you need to take.

Step 2.1 – get credentials to authenticate

If you’ve completed step 1 above, you will receive an email with the following information, which you can use to authenticate:

Note! Sometimes for the access to work you need to type the username in the following format: integration.user%40kivra.com.legalapi

  • password: (password from Kivra)
  • clientid: (clientid for authentication from Kivra)
  • clientsecret: (clientsecret for authentication from Kivra)

Note! Your clientid and clientsecret for the legal API are unique. Don’t use other clientid and clientsecret for other APIs (e.g for the tenant API) here.

Step 2.2 – call the legal API

After authentication, use the following information to call the legal API:

  • Authorization: Bearer (access token from authentication)
  • clientId: (clientId received from Kivra Core)
  • content-type: application/json

Note! client_id used for authentication and clientId used for calling the legal API are not the same. In this step you should use the same clientId that you’re using when creating a tenant in the tenant API.

For further documentation on calling the legal API, import the file testkivraLegalApiv1.json into your API editor (e.g. https://editor.swagger.io/).

Step 3 – set up the production environment

After familiarizing yourself with the test environment, you’re ready to move on to the production environment. This process is very similar to the test environment process.

Step 3.1 – authenticate

Use the following information to authenticate:

Note! Sometimes for the access to work you need to type the username in the following format: integration.user%40kivra.com

  • password: (password from Kivra)
  • clientid: (clientid for authentication from Kivra)
  • clientsecret: (clientsecret for authentication from Kivra)

Note! Your clientid and clientsecret for the legal API are unique. Don’t use other clientid and clientsecret for other APIs (e.g for the tenant API) here.

Step 3.1 – call the legal API

After authentication, use the following information to call the legal API:

  • Authorization: Bearer (access token from authentication)
  • clientId: (clientId received from Kivra Core)
  • content-type: application/json

Note! client_id used for authentication and clientId used for calling the legal API are not the same. In this step you should use the same clientId that you’re using when creating a tenant in the tenant API.

For further documentation on calling the legal API, import the file kivraLegalApi_v1.json into your API editor (e.g. https://editor.swagger.io/).

Got feedback? We'd love to hear it!