Describing your organisation in the API Catalogue
This instruction describes what organisational information should be described in the API Catalogue Opens in a new window.and what information is retrieved by it automatically.
What information is added to the API Catalogue automatically?
When an organisation joins the Suomi.fi Data Exchange Layer, its basic data is retrieved by the API catalogue automatically. The data retrieval process may take a few days.
You can edit your data in the API Catalogue, in which case any manual changes will overwrite the data that was retrieved automatically. The information that is retrieved depends on your organisation’s type:
- Public organisation
- Private organisation
Public organisation
In this context, a public organisation is an organisation whose identifier on the Data Exchange Layer is MUN, GOV or PUB. The information concerning these organisations is retrieved from the Suomi.fi Finnish Service Catalogue (PTV). This information is updated automatically in the API Catalogue if you change it in the Suomi.fi Finnish Service Catalogue. Please note that if you manually change your information in the API Catalogue, the changes made in the Suomi.fi Finnish Service Catalogue will no longer be updated to the API Catalogue.
The following data is imported into the API Catalogue:
- Organisation type
- Business ID
- Customer service contact details
- Homepage
- Description of the organisation.
Private organisation
A private organisation is an organisation whose identifier on the Data Exchange Layer is COM and whose data cannot be found in the Suomi.fi Finnish Service Catalogue. Information concerning private organisations is retrieved through the Finnish Patent and Registration Office’s (PRH) interface. Any changes made to the organisation’s information by the PRH are automatically updated to the API Catalogue. Please note that if you manually change your information in the API Catalogue, the changes made by the PRH will no longer be updated to the API Catalogue.
The following data is imported into the API Catalogue:
- Form of business
- The company's postal address
- The company's operating language
- Date of registration
- Business ID change history.
How can I edit my organisation’s information?
You can change your organisation’s information by managing the organisation. You must have permission to edit your organization’s information in the API Catalogue. Change information as follows:
- Log in to the API Catalogue.
- Go to your organisation's information in the API Catalogue and select Manage.
If you do not have permission to edit your organisation’s information, ask your organisation’s API Catalogue administrator to grant you the necessary permissions. If your organisation does not have anyone with the permissions for editing your organisation’s information, you will have to ask for the necessary permissions and IDs from API Catalogue maintenance at palveluvayla@palveluvayla.fi.
What do I need to include in the description of my organisation?
Provide a general overview of your organisation:
- Name of the organisation
- Organisation's tasks
You can also briefly specify what kinds of subsystems and services your organisation provides through the Data Exchange Layer. Your description can also include a link to your organisation’s website.
Your description should also be available in Swedish and English.
For example, the Digital and Population Data Services Agency’s organisation descriptionOpens in a new window. provides a concise description of the organisation. The description also includes a link to the agency’s website.
The information concerning public organisations is retrieved from the Suomi.fi Finnish Service Catalogue (PTV). However, you can modify the description in the API Catalogue to include information about the services your organisation provides in the Data Exchange Layer.
Your organisation should have a logo/image in the API Catalogue. To add an image
- from your workstation, select Upload.
- from an URL, select Link.