Skip to content
KivraAPI Reference
This is a new version of the Kivra Developer Docs. Report issues or share feedback at avsandare.support@kivra.se. The previous version can be found here.

Overview

Tenant API 1.0.0

Section titled “Tenant API 1.0.0”

Endpoint contracts for managing tenants and sending content through Kivra.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
POST
/v1/auth
GET
/v2/tenant
POST
/v2/tenant
GET
/v2/tenant/{tenantKey}
PUT
/v2/tenant/{tenantKey}/name
POST
/v2/tenant/{tenantKey}/company_id
DELETE
/v2/tenant/{tenantKey}/company_id/{orgNr}
POST
/v2/tenant/{tenantKey}/icon
POST
/v2/tenant/request_access
GET
/v2/tenant/request_access/{requestKey}
POST
/v2/tenant/{tenantKey}/usermatch/ssn
POST
/v2/tenant/{tenantKey}/usermatch/verified_email
POST
/v2/tenant/{tenantKey}/companymatch/vatnr
POST
/v2/tenant/{tenantKey}/companymatch/vatnr_with_active_partner_integration
GET
/v1/tenant/{tenantKey}/company
GET
/v2/tenant/{tenantKey}/company
GET
/v2/tenant/{tenantKey}/company/diff/{diffId}
POST
/v2/tenant/{tenantKey}/content
GET
/v2/tenant/{tenantKey}/form
POST
/v2/tenant/{tenantKey}/form
GET
/v2/tenant/{tenantKey}/form/{formTemplateKey}
GET
/v2/tenant/{tenantKey}/form/{formTemplateKey}/responses
GET
/v2/tenant/{tenantKey}/form/{formTemplateKey}/responses/{formResponseKey}
DELETE
/v2/tenant/{tenantKey}/form/{formTemplateKey}/responses/{formResponseKey}
GET
/v2/tenant/{tenantKey}/registered
GET
/v2/tenant/{tenantKey}/registered/{responseKey}
DELETE
/v2/tenant/{tenantKey}/registered/{responseKey}
POST
/v2/tenant/{tenantKey}/ticket/event
GET
/v1/tenant/{tenantKey}/agreement
POST
/v1/tenant/{tenantKey}/agreement
GET
/v1/tenant/{tenantKey}/agreement/{agreementKey}
POST
/v1/tenant/{tenantKey}/agreement/{agreementKey}/revoke
GET
/v1/tenant/{tenantKey}/agreement/{agreementKey}/covenant
GET
/v2/webhooks/payments
POST
/v2/webhooks/payments
DELETE
/v2/webhooks/payments/{id}
PATCH
/v2/webhooks/payments/{id}
POST
/v2/webhooks/payments/{id}/test
POST
Payment webhook WEBHOOK

Authentication

Section titled “Authentication”

basicAuth

Section titled “basicAuth”

Security scheme type: http

oAuth2Client

Section titled “oAuth2Client”

Security scheme type: oauth2

Flow type: clientCredentials

Token URL: https://sender.api.kivra.com/v1/auth