XBRL receiving API to the Finnish Trade Register

This instruction is intended for service providers who maintain financial administration software.

A software company can deploy the PRH’s receiving API to submit a structured financial statement in IXBRL format to the Finnish Trade Register.

The API can be used free of charge.

The PRH does not provide a customer software to use the API (interface). Therefore, the software companies must create a sufficient function in their own financial administration system to be able send the iXBRL financial statements to the Trade Register.

What kind of financial statements can I send through the API interface?

The API currently receives limited liability companies, cooperatives and certain financial sector companies financial statements in iXBRL format.

Financial statements must be filed using IXBRL (Inline eXtensible Business Reporting Language). In IXBRL financial statements, the XBRL details are embedded in the HTML content.

The data are presented uniformly in accordance with standards and classifications (taxonomies), however in a visual format that users are accustomed to. There are no other requirements for showing the details. The financial statements can therefore be visualised as you wish, as long as they are based on the IXBRL standards.

Check the up-to-date situation of which business forms and taxonomies the API supports.

What kind of API?

The interface is a REST API. Users are identified through a separate authentication server, which provides the access token used in actual API calls.

In the API, a separate query is used to retrieve information about what kind of company types or taxonomy versions the API is currently supporting.

Metadata, such as the Business ID and the start date and end date of the financial period, are submitted together with the financial statements or the annual report. Read the API description for more information about the metadata submitted in connection with a call.

When the data are uploaded, they are validated at different levels to ensure their registration for the correct company and their technical integrity. If the validation of the submission is successful, the API returns a successful response. In other cases, an error code and a more accurate description of the error reason are returned. Once they have been successfully validated, the data can be uploaded.

The API is open around the clock.

How can I start to use the API?

Before activating the API connection, its terms of use must be accepted. The PRH provides a test server for testing the API. The PRH also offers support and instructions for the deployment.

The terms of use of the API include a more detailed description of the testing use of the interface and the requirements for starting production use.

Materials to support API development

See the dedicated page for useful materials that support software companies' development work. Go to this page to download the latest versions of the necessary instructions.

Do you need more information?

The PRH sends out newsletters about structured financial statement reporting to software companies.

The PRH also provides support for developing structured financial statements and deploying the API.