People rest API
Economic background
The API return the person's family, education and background in JSON format, as specified by Bisnode ID.
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).
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/ihmiset/v1/Finance - production environment
- https://api-test.bisnode.fi/ihmiset/v1/Finance - test environment
API response
| Data element | Description |
|---|---|
| BisnodeId | The unique person id. e.g. FI2101004932316 |
| Person's ordinary income | Estimated ordinary income (personal) is shown in classes 1-10. Class 1: less than 15 287 €/year. Class 10: over 42 263 €/year. |
| Household's ordinary income | Estimated ordinary income (household) is shown in classes 1-10. Class 1: less than 18 061 €/year. Class 10: over 78 286 €/year. |
| Person's capital gains | Estimated capital gains (personal) are shown in classes 1-10. Class 1: less than 144 €/year. Class 10: over 3 095 €/year. |
| Household's capital gains | Estimated capital gains (household) are shown in classes 1-10. Class 1: less than 271 €/year. Class 10: over 4 296 €/year. |
| Person's debts | Estimated debts (personal) are shown in classes 1-10. Class 1: less than 3 332 €. Class 10: over 54 729 €. |
| Household's debts | Estimated debts (household) are shown in classes 1-10. Class 1: less than 4 025 €. Class 10: over 93 169 €. |
API request parameters
| Parameter | Description | |
|---|---|---|
| id | Bisnode ID. | X |
| X = Mandatory | ||
API request and response example
https://api.bisnode.fi/ihmiset/v1/Finance?id=FI2101004932316
Successful request and the API return results in JSON format.
{
"BisnodeId": "FI2101004932316",
"Household_income": 7,
"Person_income": 9,
"Person_income_from_capital": 9,
"Household_income_from_capital": 10,
"Person_debt": 6,
"Household_debt": 7
}