Monitoring APIs

Register info

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

Only Population Register Centre data is available through APIs. Use of APIs requires a permission issued by Population Register Centre.

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.

SWAGGER - Developer REST API documentation - read more »


  • - production environment
  • - test environment

Request parameters

id Register ID M


Request and response example

curl '' -H 'x-api-key: ABC1234567890'

Successful API request returns results in JSON format.

  "registerId": 181,
  "registerName": "Customers",
  "events": [
      "id": 909,
      "typeId": 1,
      "typeName": "Upsert items",
      "timestamp": "2017-05-08T10:51:01.253Z"
      "id": 910,
      "typeId": 3,
      "typeName": "Matching started",
      "timestamp": "2017-05-08T10:51:02.533Z"
      "id": 911,
      "typeId": 4,
      "typeName": "Matching ended",
      "timestamp": "2017-05-08T10:52:04.13Z"
      "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 »