Monitoring APIs

Register Info

The API returns register basic info: name (if named), the total number of items in the register, number of matched items in the register, and last 1 000 register usage events

Only Population Register Centre people related basic information (e.g., name, address, deceased) is available through APIs. To use of that basic information requires permission issued by Population Register Centre. Bisnode's data elements (e.g., credit remarks, predictions) can be used without the Population Register Centre permission through APIs.

To use the API, you must have a valid environment-specific REGISTER ID and API KEY. You will get a valid REGISTER ID and API KEY from the Bisnode's Customer Service. The API KEY must be sent in the request custom header element (named: x-api-key). If the API KEY value is valid, then the 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.

SWAGGER - Developer REST API documentation - read more »

API endpoints

https://api.bisnode.fi/people/register-monitor/v2/register - PROD
https://api-test.bisnode.fi/people/register-monitor/v2/register - TEST

API request

Parameter	Description
id	Register ID	M
M = Mandatory

GET https://api-test.bisnode.fi/people/register-monitor/v2/register/{id}

API response

Element	Description
registerId	The register id
registerName	The name of the register
itemCount	Total count of the items in the register
matchedItemCount	The count of the matched (identified) items in the register

API request and response example

curl 'https://api-test.bisnode.fi/people/register-monitor/v2/register/181' -H 'x-api-key: ABC1234567890'

Successful API request returns results in JSON format.

{
  "registerId": 181,
  "registerName": "Ab Hello Oy customer register",
  "events": [
    {
      "id": 909,
      "typeId": 1,
      "typeName": "Upsert items",
      "timestamp": "2017-05-08T10:51:01.253Z"
    },
    {
      "id": 912,
      "typeId": 5,
      "typeName": "Populated matching results",
      "timestamp": "2017-05-08T10:52:04.31Z"
    }
  ],
  "itemCount": 501299,
  "matchedItemCount": 491001
}

More detailed implementation guide for the API - read more »