Software developers

The Incomes Register’s interfaces

The interface means an electronic connection built between different systems and the Incomes Register.

The Incomes Registers offers several technical interface for data submitters and users. The data format of the Incomes Register’s technical interfaces is XML, and schemas are in English.

Software developers need to ensure that the built service corresponds to the Incomes Register’s technical documentation and schedule requirements. Consider the following:

• We process records in their order of arrival.
• The processing time depends on such factors as the size of the record sent. We recommend that you send records containing a maximum of 3,000 reports to the Incomes Register.
• Data submitters need to use processing feedback to ensure that their reporting was successful. We recommend that you allow at least five minutes between sending your record and requesting processing feedback.
• If you have not received processing feedback within five minutes, we recommend that you wait at least another five minutes before requesting it again. This will avoid unnecessary requests.
• If you do not receive the processing feedback within two hours even if you waited the recommended five minutes between requests or if you received the message-level (MessageErrors) error code “GEN0010 Unexpected technical error”, please contact us by filling in the observation report.

Read all the recommendations for using the interface in the content descriptions submitting data to the Incomes Register and distribution of data from the Incomes Register.

Interfaces for payers

You can report data using the real-time or deferred Web Service interface, or the SFTP interface.

• In the real-time WS interface, reports are submitted to the Incomes Register one at a time. The interface is intended for situations where there are only a few reports and where processing feedback is required immediately.
• If a large number of reports need to be submitted to the Incomes Register at the same time, the deferred Web Service interface or the SFTP interface should be used. Using these interfaces, several reports can be submitted through a single record.

Payers, or data providers, need to submit an application for using the technical interface in the Incomes Register's e-service.

Application for using the technical interface and certificate

Interfaces for data users

The data saved in the Incomes Register can only be used by the authorities and other parties that have a statutory right to use them.

The Incomes Register’s data can be distributed using the SFTP interface and the real-time Web Service interface.

Data users need to submit an application for using the technical interface by filling in a report by the Incomes Register data user for data permission purposes. The provision of the data permission starts the first certificate request. When their data permission is in effect, organisations can request more certificates in the Incomes Register's e-service.