Skip to main content
API docs by Redocly

Signicat Monitor (v1)

Download OpenAPI specification:Download

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

This API enables monitoring of organization through registries.

Monitor Endpoints

Get monitor

This endpoint allows to get monitor by Id from the system.

path Parameters
monitorId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "402d1ce2-ce71-4f9b-b252-3fa90fef0de4",
  • "accountId": "a-ppge-c5jsmhR5fLM3jxBY8H1v",
  • "name": "Monitor Name",
  • "sources": [
    ],
  • "profiles": [
    ],
  • "description": "Monitor that reach source",
  • "size": 10,
  • "entityType": "Organisation",
  • "createdAt": "2025-05-21T11:11:17.4881021Z",
  • "isEnabled": true
}

Create monitor

This endpoint allows the creation of a new monitor resource in the system.

Request Body schema: application/json
required
name
string or null
description
string or null
entityType
string or null
Array of objects or null (SourcesDto)
profiles
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "name": "Monitor Name",
  • "description": "Monitor that reach source",
  • "entityType": "Organisation",
  • "sources": [
    ],
  • "profiles": [
    ]
}

Organisation Endpoints

Add organisation

This endpoint allows the creation of a new organisation to monitor in the system.

path Parameters
monitorId
required
string <uuid>
Request Body schema: application/json
required
Array
organisationNumber
required
string or null
source
string or null
country
string or null
companyName
string or null
referenceKey
string or null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get organisation

This endpoint allows to get the organisation last snapshot by monitor id and reference key from the system.

path Parameters
monitorId
required
string <uuid>
referenceKey
required
string

Responses

Response samples

Content type
application/json
{
  • "country": "NOR",
  • "name": "Organisation Name",
  • "added": "2025-05-20T11:11:17.519182Z",
  • "lastUpdate": "2025-05-21T11:11:17.5192075Z",
  • "organisationNumber": "12345678",
  • "operationalStatus": null,
  • "externalId": "1454-15",
  • "alias": "Organisation Alias",
  • "legalForm": "Other",
  • "screening": {
    }
}

Delete organisation associated to a monitor

This endpoint allows to delete the organisation from the system in one specific monitor.

path Parameters
monitorId
required
string <uuid>
referenceKey
required
string

Responses

Get organisation changes by monitor and reference key

This endpoint allows to get the organisation all changes by monitor id and reference key from the system.

path Parameters
monitorId
required
string <uuid>
referenceKey
required
string
query Parameters
cursor
required
integer <int32>
limit
integer <int32>
Default: 10000

Responses

Response samples

Content type
application/json
{
  • "size": 3,
  • "nextCursor": 2,
  • "limit": 10000,
  • "items": [
    ]
}

Get organisation changes from monitor

This endpoint allows to get the organisation all changes by monitor id from the system.

path Parameters
monitorId
required
string <uuid>
query Parameters
cursor
required
integer <int32>
limit
integer <int32>
Default: 10000

Responses

Response samples

Content type
application/json
{
  • "size": 3,
  • "nextCursor": 2,
  • "limit": 10000,
  • "items": [
    ]
}