People rest API
Basic information
The API returns the person's basic information in JSON format, as specified by Bisnode 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 ).
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/Person - production environment
- https://api-test.bisnode.fi/ihmiset/v1/Person - test environmenet
API response
| Data element | Description |
|---|---|
| BisnodeId | The unique person id. e.g. FI2101004131266 |
| Lastname | Person's last name. e.g. Kankkunen |
| Firstname | Person's first names (or name). e.g. Juha Pekka |
| Address | Person's street address. e.g. Kauppakatu 63 A 2 |
| Zipcode | Person's zip/postal code. e.g. 78200 |
| PostOffice | Person's post office. e.g. Porvoo |
| PhoneNumber | Person's phone number. e.g. 050453235 |
API request parameters
| Parameter | Description | |
|---|---|---|
| id | Bisnode ID | X |
| reference | The end user name or id. | |
| X = Mandatory | ||
https://api.bisnode.fi/ihmiset/v1/Person?id={id}&reference={reference}
API request and response example
https://api.bisnode.fi/ihmiset/v1/Person?id=FI2101004932316
Successful request and the API return results in JSON format.
{
"BisnodeId": "FI2101004932316",
"Lastname": "Porkka",
"Firstname": "Janne",
"Address": "Kumpulantie 3 B 12",
"Zipcode": "20740",
"PostOffice": "TURKU",
"PhoneNumber": "0501526607"
}