People rest api

Autocomplete search advanced

The API can be used to provide autocomplete functionality for text-based search, by returning name, street name and city information 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

  • - production environment
  • - test environment

API response

Data elementDescription
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
Address It contains only the street name. Does not contains any street number information. e.g. Kauppakatu
PostOffice Person's current post office. e.g. Helsinki

API request parameters

Lastname Last name of the person. e.g. Pouta *
Firstname First name (or names) of the person. e.g. Matti *
Streetname Only street name, don't use street number information. e.g. Kauppakatu *
Zipcode Zip/Postal code. e.g. 78200 *
Postoffice Post office. e.g. Helsinki *
Phonenumber Phone number of the person. e.g. 044983923 *

API request and response example

curl '' -H 'x-api-key: 1234567890ABC'

Successful request and the API return results in JSON form

    "Persons": [
            "BisnodeId": "FI2101004338470",
            "Lastname": "Laaksonen",
            "Firstname": "Jukka",
            "Address": "Kumpulantie",
            "PostOffice": "HELSINKI"
            "BisnodeId": "FI2101004237425",
            "Lastname": "Laaksonen",
            "Firstname": "Jari",
            "Address": "Kauppakatu",
            "PostOffice": "HELSINKI"
            "BisnodeId": "FI2101004561468",
            "Lastname": "Laaksonen",
            "Firstname": "Janne",
            "Address": "Kuusitie",
            "PostOffice": "HELSINKI"
    "Total": 11