Introduction

Use the Tenant API to send digital communication to people and companies in Kivra on behalf of a sender, called a tenant. Authenticate your client with OAuth 2.0 (client credentials), then send content through the tenant’s content endpoint.

The API covers matching recipients, sending content, and managing tenants. Supported content includes letters, invoices, salary slips, invites, bookings, forms, registered letters and event tickets. Signature agreements are available through separate agreement endpoints.

The recipient sees the tenant’s name and icon, the subject, and the experience that belongs to the content type.

Terminology

The Tenant API uses several names for an organisation depending on the role it has in a request:

Term	Meaning in the Tenant API
Client	The organisation or system identified by client_id and client_secret. It authenticates and sends API requests, and may have access to one or more tenants.
Tenant	The sender identity represented by tenantKey. The tenant owns the content and its public name is shown to the recipient.
User	An individual person receiving content in a personal Kivra inbox, identified by ssn or a verified email.
Company	A legal entity receiving content in a Kivra Business inbox, identified by vat_number. A company identity can also be linked to a sender tenant; in that context it describes the tenant’s legal identity rather than the recipient.
Partner	A client that sends content on behalf of another tenant. “Partner” describes this delegated-sending relationship; it is not a separate recipient type.

These roles can overlap. One organisation could be a client, tenant, partner, and company all at the same time. Keep in mind what role you are while reading this guide.

Integration flow

1. Request credentials and receive client credentials and a tenant key.
2. Send your first content to the sandbox recipient.
3. Review the content in the sandbox recipient experience.

Start with sandbox credentials. Use Content to select the content type that fits your use case.