Company rest API
Person roles in Estonian companies
Get a specific person's current roles in Estonian companies.
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.
API endpoints
- https://api.bisnode.fi/company/info/v2/personrolesinestoniancompanies/ - production environment
- https://api-test.bisnode.fi/company/info/v2/personrolesinestoniancompanies/ - test environment
API request parameters
| Parameter | Description | |
|---|---|---|
| id | Social security number or Bisnode id | X |
| X = Mandatory | ||
GET https://api-test.bisnode.fi/company/info/v2/personrolesinestoniancompanies/{id}
API response
| Element | Description |
|---|---|
| bisnodeId | |
| socialSecurityNumber | |
| dateOfBirth | |
| firstNames | |
| lastName | |
| rolesInEstonianCompanies: | |
| localBusinessId | The company's Estonian business id |
| companyName | The company's name |
| companyStatusCode | For descriptions see Codes API CodeKey = "STC" |
| roleCode | For descriptions see Codes API CodeKey = "ROC" |
| roleStartDate | |
| roleEndDate | |
API request and response example
curl 'https://api-test.bisnode.fi/company/info/v2/personrolesinestoniancompanies/FI2101005032547' -H 'ticket: 1234567890ABC'
Successful request and the API return results in JSON format.
{
"bisnodeId": "FI2101005032547",
"socialSecurityNumber": "071072-XXXX",
"dateOfBirth": "1972-10-07T00:00:00Z",
"firstNames": "Janne Jaakko",
"lastName": "Reiss",
"rolesInEstonianCompanies": [
{
"localBusinessId": "25125831",
"companyName": "Nordic Blueberry OÜ",
"companyStatusCode": "200",
"roleCode": "HPJ",
"roleStartDate": "2012-11-22T00:00:00Z",
"roleEndDate": null
},
{
"businessId": "12042155",
"companyName": "Noxicon",
"companyStatusCode": "100",
"roleCode": "OS",
"roleStartDate": "2003-02-19T00:00:00Z",
"roleEndDate": null
}
],
"rolesInEstonianCompaniesHistory": []
}
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.