People rest API
Additional information
The API returns the person's additional information in JSON format, as specified by ID or person identification 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.
API endpoints
- https://api.bisnode.fi/ihmiset/v1/PersonExtended - production environment
- https://api-test.bisnode.fi/ihmiset/v1/PersonExtended - test environment
API response
| Data element | Description |
|---|---|
| BisnodeId | The unique person id. e.g. FI2101005032599 |
| Lastname | Person's last name. e.g. Meikäläinen |
| Firstname | Person's first name. e.g. Matti Olavi |
| Address | Person's address. e.g. Kauppakatu 63 A 2 |
| Zipcode | Person's zipcode. e.g. 00980 |
| PostOffice | Person's post office. e.g. HELSINKI |
| DateOfAddress | Date when person moved to their current address. e.g. 2013-06-01T00:00:00 |
| PhoneNumber | Person's phone number. e.g. 0501234567 |
| Gender | Is person male or female. e.g. M |
| Languagecode | Person's language code. e.g. fi |
| YearOfBirth | Person's year of birth. e.g. 1985 |
| Status | Is the person alive or dead. e.g. ALIVE |
| DateOfDeath | Date of death (if person is dead). |
API request parameters
| Parameter | Description | |
|---|---|---|
| id | Bisnode ID | X |
| reference | The end user name or id | |
| X = Mandatory | ||
https://api.bisnode.fi/ihmiset/v1/PersonExtended?id={id}&reference={reference}
API request and response example
https://api.bisnode.fi/ihmiset/v1/PersonExtended?id=FI2101005032599
Successful request and the API return results in JSON format.
{
"Gender": "M",
"Languagecode": "fi",
"YearOfBirth": 1985,
"DateOfAddress": "2013-06-01T00:00:00",
"DateOfDeath": null,
"Status": "ALIVE",
"BisnodeId": "FI2101005032599",
"Lastname": "Meikäläinen",
"Firstname": "Matti Olavi",
"Address": "Kauppakatu 63 A 2",
"Zipcode": "00980",
"PostOffice": "HELSINKI",
"PhoneNumber": "0501234567"
}