Company rest API
Sanctions
The API returns company's sanction cases in JSON format, as specified by business id or duns number.
In order to use the API you must have the valid environment-specific username and password. Before any API requests, you need to obtain an API KEY. You will get a valid API KEY (it's called a ticket) by using the ticket API (Please, read how to use ticket API instructions).
The API KEY must be sent in the request custom header element (named ticket or x-api-key). If the API KEY value is valid then API request will be successful (http status code 200), otherwise it will fail (http status code 401). All API requests must be made over HTTPS.
Endpoints
- https://api.bisnode.fi/company/info/v3/sanctions - production environment
- https://api-test.bisnode.fi/company/info/v3/sanctions - test environment
Request parameters
| Parameter | Description | |
|---|---|---|
| id | Business id or duns number | X |
| X = Mandatory | ||
GET https://api-test.bisnode.fi/company/info/v3/sanctions/{id}
Response
| Element | Description |
|---|---|
| businessId | Local Company's business id (Y-tunnus) |
| dunsNumber | Company's duns number |
| caseId | Case Id |
| caseType | Case Type |
| decisionDate | Decision Date |
| authorityCode | Authority Code |
| fine | Fine (EUR) |
| extraInfo | Extra Info |
| - | - |
Request and response example
curl 'https://api-test.bisnode.fi/company/info/v3/sanctions/1966768-1' -H 'x-api-key: 1234567890ABC'
Successful request and the API return results in JSON format.
{
"businessId": "2014838-7",
"dunsNumber": "539506084",
"sanctions": [
{
"caseId": "ESAVI/1234/05.67.00.08/2019",
"caseType": "laiminlyöntimaksu",
"decisionDate": "2020-03-12T00:00:00Z",
"authorityCode": "Etelä-Suomen AVI",
"fine": 3000,
"extraInfo": ""
}
]
}
Test cases
| 1966768-1 |
| 2014838-7 |
| 1234567-8 |
Please note that data coverage varies between companies. Data coverage depends e.g. on company form. Remember the codes and descriptions API returns all companies REST APIs code values and descriptions - read more.