Skip to main content
API docs by Redocly

Signicat Person Monitor

Download OpenAPI specification:Download

Signicat: support@signicat.com URL: https://developer.signicat.io

This API enables monitoring of person name and address changes through multiple national person registries.

Changes

Endpoint for retrieving person changes for a specific monitor.

Retrieve changes

Returns a paginated result containing all changes since the last change marked as read. If the next response property is missing, there is no more data to retrieve.

path Parameters
monitorId
required
string

The monitor ID.

query Parameters
offset
integer <int32>
Default: 0

Optional cursor for pagination, which allows for paging without marking changes as read.

limit
integer <int32>
Default: 1000

Optional parameter to set how many results you want per page.

Responses

Response samples

Content type
application/json
{
  • "offset": 0,
  • "limit": 3,
  • "size": 6,
  • "links": {},
  • "data": [
    ]
}

Mark changes as read until the specified changeId

path Parameters
monitorId
required
string

The monitor ID.

query Parameters
changeId
integer <int32>

Set a cursor on the monitor so that only changes after the changeId are returned when querying for changes.

Responses

Mock changes

Manually add changes to a monitor that that was created with the isMock property set to true. The monitor will process and create changes for the persons as if they came from a population registry.

path Parameters
monitorId
required
string

The monitor ID.

Request Body schema: application/json

Changes that will be mocked.

required
Array of objects (MonitorMockPerson) non-empty

List of person changes.

source
string (Source)
Enum: "nationalRegistry" "trapets"

What kind of sources to use for monitoring

Responses

Request samples

Content type
application/json
{
  • "persons": [
    ],
  • "source": "nationalRegistry"
}

Retrieve changes for a person

Retrieves all changes for a single person, ignoring any cursors.

path Parameters
monitorId
required
string

The monitor ID.

referenceKey
required
string

The person's reference key.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Monitors

Create a monitor.

Creates a blank monitor. The monitor must be populated with person data before it can be used.

Request Body schema: application/json
name
required
string [ 1 .. 50 ] characters

Name of the monitor.

description
string or null

Description of the monitor.

sources
Array of strings or null (Source)
Enum: "nationalRegistry" "trapets"

Sources to use for monitoring, defaults to Idfy.Monitor.Person.ApiDtos.Monitor.SourceDto.NationalRegistry

allowMock
boolean
Deprecated
isMock
boolean

Set the monitor in a mock state, where you generate your own changes. This will allow you to add persons for monitoring without having credentials for the targeted population registry. This parameter is only meant for testing. You must remove it before switching to production.

Responses

Request samples

Content type
application/json
{
  • "name": "Platinum Card Owners",
  • "description": "Keeping our platinum card customer database updated",
  • "sources": [
    ],
  • "allowMock": false,
  • "isMock": false
}

Delete monitor

Deletes the monitor, removing all stored person data.

path Parameters
monitorId
required
string

The monitor ID.

Responses

Retrieve monitor information

Returns key information about the monitor.

path Parameters
monitorId
required
string

The monitor ID.

Responses

Response samples

Content type
application/json
{
  • "name": "Platinum Card Owners",
  • "enabled": false,
  • "created": "2018-06-16T15:41:20.20Z",
  • "details": {
    },
  • "allowMock": false,
  • "isMock": false
}

Retrieve monitor summaries

Retrieves a summary of your person monitors.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

/migrate/{accountId}/monitors

path Parameters
accountId
required
string
Request Body schema: application/json
id
string <uuid>
cursorId
integer <int32>
name
required
string [ 1 .. 50 ] characters

Name of the monitor.

description
string or null

Description of the monitor.

sources
Array of strings or null (Source)
Enum: "nationalRegistry" "trapets"

Sources to use for monitoring, defaults to Idfy.Monitor.Person.ApiDtos.Monitor.SourceDto.NationalRegistry

allowMock
boolean
Deprecated
isMock
boolean

Set the monitor in a mock state, where you generate your own changes. This will allow you to add persons for monitoring without having credentials for the targeted population registry. This parameter is only meant for testing. You must remove it before switching to production.

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "cursorId": 0,
  • "name": "string",
  • "description": "string",
  • "sources": [
    ],
  • "allowMock": true,
  • "isMock": true
}

/migrate/{accountId}/monitors/{monitorId}/persons/add

path Parameters
accountId
required
string
monitorId
required
string
Request Body schema: application/json
required
Array of objects (MonitorPerson) non-empty

The persons to be added to the monitor. We recommend that you keep this under 100000 persons per request.

Array (non-empty)
referenceKey
required
string [ 1 .. 100 ] characters

Reference key

firstName
string or null

The person's first name.

lastName
string or null

The person's last name.

middleName
string or null

The person's middle name.

dateOfBirth
string or null <yyyy-MM-dd>

The person's date of birth, if available.

nationalIdentityNumber
string or null

The person's national identity number, if available.

nationality
required
string = 2 characters

Determines which population registry to use when looking up the person (ISO 3166-1 alpha-2).

object (PersonAddress)

The person's address

object (PersonScreening)

Attribute providing information about the Screening status of the person

Responses

Request samples

Content type
application/json
{
  • "persons": [
    ]
}

/migrate/changes

Request Body schema: application/json
Array
changeId
string or null
personReference
string or null
status
integer <int32>
personData
string or null
changedAt
string <date-time>
createdAt
string <date-time>
source
integer <int32>
monitorId
string <uuid>
accountId
string or null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

/migrate/changelogs

Request Body schema: application/json
Array
id
string or null
monitorId
string <uuid>
createdAt
string <date-time>
status
integer <int32>
changes
integer <int32>
accountId
string or null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

/migrate/reverselookups

Request Body schema: application/json
Array
monitorId
string <uuid>
personReference
string or null
valueType
integer <int32>
value
string or null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

/migrate/{accountId}

path Parameters
accountId
required
string

Responses

Persons

Endpoints for managing the persons for a specific monitor.

Each person must have a reference key which uniquely identifies the person within the monitor. The reference key should also allow you to identify the person within your own systems.

Add a person

Adds the specified person to the monitor. The supplied information must be enough to securely identify them. The national identity number must always be included.

path Parameters
monitorId
required
string

The monitor ID.

referenceKey
required
string

The person's reference key.

Request Body schema: application/json

Information about the person you want to add.

firstName
string or null

The person's first name.

lastName
string or null

The person's last name.

middleName
string or null

The person's middle name.

dateOfBirth
string or null <yyyy-MM-dd>

The person's date of birth, if available.

nationalIdentityNumber
string or null

The person's national identity number, if available.

nationality
required
string = 2 characters

Determines which population registry to use when looking up the person (ISO 3166-1 alpha-2).

object (PersonAddress)

The person's address

object (PersonScreening)

Attribute providing information about the Screening status of the person

Responses

Request samples

Content type
application/json
{
  • "firstName": "Hedda",
  • "lastName": "Hansen",
  • "middleName": "T.",
  • "dateOfBirth": "1970-02-20",
  • "nationalIdentityNumber": "24107749383",
  • "nationality": "NO",
  • "address": {
    }
}

Get a person

Get the latest information about the person with the supplied referenceKey.

path Parameters
monitorId
required
string

The monitor ID.

referenceKey
required
string

The person's reference key.

Responses

Response samples

Content type
application/json
{
  • "fullName": "Hedda Hansen",
  • "firstName": "Hedda",
  • "lastName": "Hansen",
  • "dateOfBirth": "1984-08-16",
  • "nationalIdentityNumber": "24107749383",
  • "nationality": "NO",
  • "address": {
    },
  • "screening": {
    }
}

Remove person

Remove the specified person from the monitor.

path Parameters
monitorId
required
string

The monitor ID.

referenceKey
required
string

The person's reference key.

Responses

Add a batch of persons

Adds the provided persons to the register. Existing persons (persons from the batch whose referenceKey already exists in the system) will be updated. The information you supply about each person must be enough to securely identify them. For example, a national identity number or the combination of name and date of birth.

If any added persons are detected as invalid, a change message will be available through the changes endpoint.

path Parameters
monitorId
required
string

The monitor ID.

Request Body schema:

The list of persons to be added.

required
Array of objects (MonitorPerson) non-empty

The persons to be added to the monitor. We recommend that you keep this under 100000 persons per request.

Array (non-empty)
referenceKey
required
string [ 1 .. 100 ] characters

Reference key

firstName
string or null

The person's first name.

lastName
string or null

The person's last name.

middleName
string or null

The person's middle name.

dateOfBirth
string or null <yyyy-MM-dd>

The person's date of birth, if available.

nationalIdentityNumber
string or null

The person's national identity number, if available.

nationality
required
string = 2 characters

Determines which population registry to use when looking up the person (ISO 3166-1 alpha-2).

object (PersonAddress)

The person's address

object (PersonScreening)

Attribute providing information about the Screening status of the person

Responses

Request samples

Content type
{
  • "persons": [
    ]
}

Remove a batch of persons

Removes the specified persons from the monitor.

path Parameters
monitorId
required
string

The monitor ID.

Request Body schema: application/json

Reference IDs of the persons to remove from the monitor

personReferenceKeys
required
Array of strings non-empty

Reference keys of persons to be removed from monitor.

Responses

Request samples

Content type
application/json
{
  • "personReferenceKeys": [
    ]
}