KIR API offers a flexibel and efficent way of retrieving information about peoples registration data that originates from the Tax Agency. The service provides a set of functions. By providing a license key, among the call parameters, access is granted to API-functions mapped to the license key.

The KIR API is built upon common industry standards and is based on the REST-protocol.

One of the objectives with Lifecare is that the system should be as open as possible and thereby contribute to the municipalities digital eco-system. To live up to that ambition we provide a set of public API's that third party vendors can implement REST-calls to build suitable integrations for their systems. By providing public API's in this way we believe that integrating systems can easily build and design the implementation by themselves to create and add functionality to theipar application. The license key, provided with the API, grants access rights to a set of functions to be used by systems that wants to retrieve data from KIR.

When data, through the KIR API, leaves Lifecare the liabilities that TietoEVRY has regarding data confidentiality, accuracy and support will no longer prevail. TietoEVRY's liability is limited to deliver API's to the Client, or to a third party supplier on behalf of the Client, in accordance with the contract at agreed time. The Client is responsible for the data that leaves the system through KIR API.

The KIR API may return persons with protection settings. No restrictions apply neither in KIR nor at the Tax Agency. The calling application must always certify that only authorized users can access protected persons. Currently there are two protection settings that may occur. Secrecy settings, which is the lower settings of the two, and the higher registration protection. See more under the menu option Security aspects regarding access to protected persons.

If the license key also cover access to relations, it is a recommendation that restrictions should apply for users who has access to them.

The API-description describes each API in detail and how they may be used. The API's is available through the REST technology and data is transported as JSON objects.

HTTP status-/error codes are being used in error situations. See the error handling section for more information.

It is a strong recommendation that all calls to the KIR API is protected with client certificate but it is not a requirement. The municipality may decide not to use client certificate. A license key is always required.