Overview
Use the Partner API when your service needs to read a company’s Kivra Business inbox. It is built for third parties that act on behalf of companies, such as accounting, ERP, and document-management systems, which fetch invoices and other documents from the inbox and process them in their own systems.
Terminology
Section titled “Terminology”| Term | Meaning in the Partner API |
|---|---|
| Partner1 | Your organisation, identified by the client_id Kivra issues. |
| Company | A legal entity with a Kivra Business account, identified by its key and its Swedish VAT number. |
| Integration | The link between a company and a partner that lets the partner read the company’s inbox. It is activated and deactivated by the company in Kivra. |
| Content | One item in the Kivra Business inbox, such as an invoice, a letter, a scanned document, or an email. Content has metadata and one or more files (parts). |
| Part | A file in a content item, such as a PDF or an HTML body. |
Integration flow
Section titled “Integration flow”A partner cannot grant itself access to a company. An authorised user of the company activates an integration with you in Kivra, and from then on your client can read that company’s inbox until the company deactivates it. Kivra tells you about each step with webhooks, and the Integration guide walks through them with examples.
Footnotes
Section titled “Footnotes”-
The Tenant API uses “partner” for a client that sends on behalf of another tenant. That role is unrelated to the Partner API. ↩