People rest API

Location - Address

The API returns all people based on address in JSON format

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.

Request the username and password

API endpoints

https://api.bisnode.fi/people/info/v2/location-with-address - production environment
https://api-test.bisnode.fi/people/info/v2/location-with-address - test environment

API response

Data element	Description
BisnodeId	The unique person id. e.g. FI2101005061055
x	Longitude. e.g. 24.942014
y	Latitude. e.g. 60.196467

API request parameters

Parameter	Description
streetAddress	example: Kumpulantie 3	X
postalCode	example: 00520	X
radius	Radius of circle in meters. Max 5000 meters.	X
coordinateSystem	Wgs84 (default) or Tm35Fin
X = Mandatory

https://api-test.bisnode.fi/people/info/v2/location-with-address?streetAddress={streetAddress}&postalCode={postalCode}&radius={radius}&coordinateSystem={coordinateSystem}

cURL request example

curl 'https://api-test.bisnode.fi/people/info/v2/location-with-address?streetAddress=Kumpulantie%203&postalCode=00520&radius=25' -H 'x-api-key: 1234567890ABC'

API request and response example

GET https://api-test.bisnode.fi/people/info/v2/location-with-address?streetAddress=Kumpulantie%203&postalCode=00520&radius=25

Successful request and the API return results in JSON format.

{
"coordinateSystem": "Wgs84",
"count": 11,
"errorMessage": null,
"hits": [
{
"bisnodeId": "FI2101005061055",
"x": 24.942014,
"y": 60.196467,
"distanceInMeters": 0
},
{
"bisnodeId": "FI2101005066333",
"x": 24.942014,
"y": 60.196467,
"distanceInMeters": 0
},
{
"bisnodeId": "FI2101010969656",
"x": 24.942014,
"y": 60.196467,
"distanceInMeters": 0
},
{
"bisnodeId": "FI2101010969657",
"x": 24.942014,
"y": 60.196467,
"distanceInMeters": 0
},
{
"bisnodeId": "FI2101010969658",
"x": 24.942014,
"y": 60.196467,
"distanceInMeters": 0
},
{
"bisnodeId": "FI2101010969659",
"x": 24.942014,
"y": 60.196467,
"distanceInMeters": 0
},
{
"bisnodeId": "FI2101010969660",
"x": 24.942014,
"y": 60.196467,
"distanceInMeters": 0
},
{
"bisnodeId": "FI2101010969661",
"x": 24.942014,
"y": 60.196467,
"distanceInMeters": 0
},
{
"bisnodeId": "FI2101010969662",
"x": 24.942014,
"y": 60.196467,
"distanceInMeters": 0
},
{
"bisnodeId": "FI2101010969663",
"x": 24.942014,
"y": 60.196467,
"distanceInMeters": 0
},
{
"bisnodeId": "FI2101010969666",
"x": 24.942014,
"y": 60.196467,
"distanceInMeters": 0
}
]
}