Family, education and background

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/Family - production environment
• https://api-test.bisnode.fi/ihmiset/v1/Family - test environment

API response

Data element	Description
BisnodeId	The unique person ID. e.g. FI2101004932316
Person's education level	Estimated education level (personal) is shown in classes 1-10. Class 1: low educated. Class 10: highly educated.
Household's education level	Estimated education level (household) is shown in classes 1-10. Class 1: low educated. Class 10: highly educated.
Households with children under 18 years	Under 18-year-old minors live in this household are shown in classes 1-10. Class 1: no. Class 10: yes.
Households with children under 10 years	Under 10 years old minors live in this household are shown in classes 1-10. Class 1: no. Class 10: yes.
Households with children over 10 years	Over 10 years old minors live in this household are shown in classes 1-10. Class 1: no. Class 10: yes.
Person's ownership of home	Person's living form estimated probability is shown in classes 1-10. Class 1: living in owner-occupied housing, Class 10: lives in rented housing.
Autonhallinta	Estimation if the person owns a car. Estimation is shown in classes 1-10. Class 1: does not own a car, Class 10: does own a car.

 

API request parameters

Parameter	Description
id	Bisnode ID.	X
X = Mandatory

 

API request and response example

https://api.bisnode.fi/ihmiset/v1/Family?id=FI2101004932316

Successful request and the API return results in JSON format.

{
"BisnodeId": "FI2101004932316",
"Person_education": 8,
"Household_education": 6,
"Family_with_children": 8,
"Family_with_children_under_10": 7,
"Family_with_children_10_to_17": 10,
"Residency": 7,
"Car_ownership": 9
}