For software developers

On this page, we have collected information and instructions on the register’s APIs and on stakeholder testing:

• Documentation: this page contains technical instruction documents, such as API descriptions
• Stakeholder testing: this page contains instructions on stakeholder testing
• Certificate: this page contains information on certificates needed for the use of APIs.

In addition to technical instructions, also read important instructions for filing and requesting data: 

• Reporting data to the Positive credit register: this instruction document tells you what the reporting obligation means, which credits must be reported to the register, what data content must be reported, what the deadlines are and how you should report the data.
• Sharing information from the Positive credit register: this page describes what data you can request from the register, or what information the register can disclose, to whom and for what purposes.

Technical APIs and their use

The users of the register, i.e. the data notifiers and data users, communicate through APIs. A technical API is an access point created in accordance with certain specifications and used for sending information between external parties and the register. The register's APIs are REST interfaces with JSON data content.

To access APIs, the user needs a certificate issued by the Tax Administration. The certificate identifies the organisation using the API and ensures data integrity. Further information on the certificate and its retrieval is available on the Certificate page. Different certificates are needed for the production environment and the testing environment.

APIs for reporting data, and their addresses

The APIs for reporting data that are available to lenders are listed below. To use these APIs, the lender needs a certificate for reporting data.

New loans: https://api.positiivinenluottotietorekisteri.fi/AddLoans

• Use this API to report your existing loans. Also report data on new loans through this API.
• Reporting data on loan contracts – API description on page documentation.
• Reporting data to the Positive credit register instuction page.

Changes to loans: https://api.positiivinenluottotietorekisteri.fi/UpdateLoans

• Use this API to report certain changes to loan contract data. Note that the following changes are not reported through this API: payment transactions, delayed amounts, acceleration, and the end or transfer of a loan. Report these changes through other APIs.
• Reporting data on loan contracts – API description on page documentation.
• Reporting data to the Positive credit register instuction page.

Payment transactions: https://api.positiivinenluottotietorekisteri.fi/Repayments

• Use this API to report payment transactions relating to loans.
• Reporting data on loan contracts –  API description on page documentation.
• Reporting data to the Positive credit register instuction page.

Delayed amounts: https://api.positiivinenluottotietorekisteri.fi/DelayedRepayments

• Use this API to report payments that are more than 60 days late, and to report if a loan is accelerated.
• Reporting data on loan contracts – API description on page documentation.
• Reporting data to the Positive credit register instuction page.

End of loan contract: https://api.positiivinenluottotietorekisteri.fi/TerminateLoans

• Use this API to report that a loan ends or is transferred to another lender.
• Reporting data on loan contracts – API description on page documentation.
• Reporting data to the Positive credit register instuction page.

Batch status inquiry: https://api.positiivinenluottotietorekisteri.fi/GetBatchStatus

• After submitting a batch, always make a status inquiry by batch reference. The response message you receive will specify any errors detected in the batch.
• Reporting data on loan contracts – API description on page documentation.
• Reporting data to the Positive credit register instuction page.

Checking loan data: https://api.positiivinenluottotietorekisteri.fi/GetLoan

• Use this API to check data on an individual loan. Specify the loan by loan number.
• Checking loan data – API description on page documentation.
• Reporting data to the Positive credit register instuction page.

API for requesting data

Lenders can use the API below to request data. To access the API, lenders need a certificate for requesting data.

Requesting credit register extracts: https://api.positiivinenluottotietorekisteri.fi/GetCreditRegisterExtract

• In this API, you can request a credit register extract by personal identity code.
• Requesting a credit register extract – API description on page dcumentation.
• Sharing information from the Positive credit register instruction page.