Retrieve all reference keys for a monitor

We have added a new endpoint to our Signicat Ongoing Monitoring API to retrieve the reference keys of all persons or organisations registered under a monitor.

You can use the endpoint to reconcile your monitored entities, recover reference keys that are unavailable in your systems and synchronise your applications with Ongoing Monitoring without maintaining a separate list of reference keys.

Key features​

• Persons and organisations: Retrieve reference keys for either entity type.
• Pagination: Retrieve reference keys in pages, including for monitors containing large numbers of entities.
• Pagination metadata: Responses include total items, total pages, current page, page size and navigation indicators.
• Secure access: Only authorised customers can retrieve reference keys belonging to their monitors.

Retrieving reference keys​

Send a GET request to /info/monitor/{monitorId}/referenceKey, using the ID of your monitor as monitorId.

The endpoint supports the following optional query parameters:

• page: The page number to retrieve. Defaults to 1.
• pageSize: The maximum number of reference keys to return per page.

Request example:

GET /info/monitor/<MONITOR_ID>/referenceKey?page=1&pageSize=1000

Response example (HTTP 200):

{
  "monitorId": "m-example123",
  "pagination": {
    "totalItems": 2500,
    "totalPages": 3,
    "currentPage": 1,
    "pageSize": 1000,
    "hasNextPage": true,
    "hasPreviousPage": false
  },
  "referenceKeys": [
    "reference-key-001",
    "reference-key-002"
  ]
}

The response is illustrative. The referenceKeys array is shortened for readability.

Compatibility​

This is an additive API enhancement. Existing monitoring endpoints remain unchanged, and no migration is required.

For more information, see our Ongoing Monitoring API reference.