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 response
| Data element | Description |
|---|---|
| BisnodeId | The unique person id. e.g. FI2101004932316 |
| Bric | Includes the following elements: PurchasingPower, LifeStage, ResidentalArea, HousingType, EducationLevel, HomeOwnership, PaymentDefaultRisk. |
| Purchasing power | Estimated purchasing power of over 18 years of age are shown in classes 1-4. Class 1: low purchase power. Class 4: significant purchase power. |
| Life stage | An assessment of what kind of life stage people living in the area are over 18 years of age. Assesment is shown in classes 1-4. Class 1: young adults without children. Class 4: seniors. |
| Payment default risk | An estimate of the default risk of people over 18 years of age living in the area. The estimate is shown in classes 0-3. Class 0: low risk of payment default. Class 3: high risk of payment default. |
| Housing type | An estimate what is the general type of residence in the area. Estimate is shown in classes 1-2. Class 1: a house. Class 2: apartment house. |
| Education level | An assessment of the education of persons over 18 years of age living in the area. Assesment is shown in classes 1-3. Class 1: primary school. Class 4: university. |
| Home ownership | An estimate of what the ownership of the apartment is in the area. Estimate is shown in classes 1-2. Class 1: owner-occupied house. Class 2: rental apartment. |
| Residental area | An estimate of the type of residential area and is expressed as following classes. Class 1: countryside. Class 2: conurbation. Class 3: city. Class 4: metropolis (Tampere, Oulu, Turku, Kuopio, Lahti). Class 5: Metropolitan Area of Helsinki (Helsinki, Espoo, Vantaa). |
| Suomi360 lifestage | The whole population is divided into eight groups. Here are more detailed descriptions of groups. |
API request parameter
| Parameter | Description | |
|---|---|---|
| id | Bisnode ID. | X |
| X = Mandatory | ||
API request and response example
https://api.bisnode.fi/ihmiset/v1/Environment?id=FI2101004932316
Successful request and the API return results in JSON format.
{
"BisnodeId": "FI2101004932316",
"bric": {
"PurchasingPower": "3",
"LifeStage": "3",
"ResidentalArea": "4",
"HousingType": "2",
"EducationLevel": "3",
"HomeOwnership": "1",
"PaymentDefaultRisk": "1"
},
"s360": {
"Suomi_360": "5"
}
}
Swagger documentation - read more!»