Production documentation
Here you can find documentation regarding the register’s current production environment. The register is continuously being developed, and future changes can be found under Upcoming changes on the Documentation page.
This page contains the documentation currently used in production. If you are looking for the documentation of the second stage, go to Second stage documentation.
API descriptions
API descriptions describe the data content to be reported and the structure of the message to be sent to the API and the response message returned from the API.
- Reporting data on loan contracts – API description (pdf) version 1.8
- Checking loan data – API description (pdf) version 1.4
- Requesting a credit register extract – API description (pdf) version 1.5
API processing rules and error codes
This document is a detailed description of the processing rules of each item of data reported to the register and of the error codes that the API shows in different error situations.
Message examples
Also study examples of messages sent to different APIs:
- Message example content (pdf) version 1.3
- Message examples (zip) version 1.3
Schema descriptions
Schema descriptions describe the structure and content of different messages, and uncomplicated rules regarding required/optional data. The descriptions do not contain rules regarding data fields’ conditionally required data, nor more complicated validations related to the system’s data content. These can be found in API descriptions.
- Schema descriptions (zip) (updated 14 June 2024)