Signicat Changes API

Endpoint for retrieving person changes for a specific monitor.

Operations 4

GET /monitors/{monitorId}/changes Retrieve changes #
POST /monitors/{monitorId}/changes/mark Mark changes as read until the specified changeId #
POST /monitors/{monitorId}/changes/mock Mock changes #
GET /monitors/{monitorId}/changes/persons/{referenceKey} Retrieve changes for a person #

Documentation

📖
APIReference
https://developer.signicat.com/apis/data-verification/
📖
APIReference
https://developer.signicat.com/apis/digital-evidence-management/
📖
APIReference
https://developer.signicat.com/apis/eid-hub/
📖
APIReference
https://developer.signicat.com/apis/electronic-signing/sign-api-v2/
📖
APIReference
https://developer.signicat.com/apis/electronic-signing/enterprise/
📖
APIReference
https://developer.signicat.com/apis/electronic-signing/express/
📖
APIReference
https://developer.signicat.com/apis/archive/
📖
APIReference
https://developer.signicat.com/apis/id-document-and-biometric-verification/
📖
APIReference
https://developer.signicat.com/apis/mobileid/
📖
APIReference
https://developer.signicat.com/apis/mobileid-admin/
📖
APIReference
https://developer.signicat.com/apis/ongoing-monitoring/
📖
APIReference
https://developer.signicat.com/apis/person-monitoring/
📖
APIReference
https://developer.signicat.com/apis/reuseid-onboarding/
📖
APIReference
https://developer.signicat.com/apis/reuseid/
📖
APIReference
https://developer.signicat.com/apis/secure-share/
📖
APIReference
https://developer.signicat.com/apis/mint/
📖
APIReference
https://developer.signicat.com/apis/siam/
📖
APIReference
https://developer.signicat.com/apis/audit-logs/
📖
APIReference
https://developer.signicat.com/apis/account-management/
📖
APIReference
https://developer.signicat.com/apis/domain-management/
📖
APIReference
https://developer.signicat.com/apis/events/
📖
APIReference
https://developer.signicat.com/apis/oidc-config/
📖
APIReference
https://developer.signicat.com/apis/usage/

Specifications

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-organization-basic-info-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-person-basic-info-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-organization-ownership-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-business-registry-registration-authority-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-geodata-country-info-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-business-registry-registration-authority-item-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-query-request-body-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-record-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-query-record-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-stats-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-session-data-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-session-request-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-signing-session-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-document-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-document-collection-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-post-document-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-paginated-signing-session-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-merchant-sign-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-signing-order-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-task-status-info-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-forwarding-info-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-event-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-artifact-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-packaging-task-status-info-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-signer-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-update-signer-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-signer-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-document-summary-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-update-signer-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-attachment-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-archive-jsonld-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-archive-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-archive-archive-objects-representation-jsonld-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-archive-archive-patch-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-audit-log-jsonld-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-archive-direct-jsonld-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-capture-configuration-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-capture-configuration-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-process-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-process-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-process-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-match-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-signature-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-account-recovery-details-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-authentication-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-registration-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-user-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-idverification-add-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-application-config-properties-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-application-config-update-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-account-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-e2-ekey-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-apnstoken-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-account-platform-all-details-statistic-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-organisation-data-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-person-response-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-monitor-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-organisation-request-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-monitor-changes-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-create-monitor-request-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-monitor-person-get-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-monitor-create-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-base-monitor-person-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-monitor-get-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-person-changes-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-paged-collection-1-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-device-signature-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-device-registration-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-device-authentication-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-passkey-authentication-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-passkey-registration-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-create-share-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-create-recipient-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-update-recipient-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-update-share-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-share-response-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-recipient-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-journey-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-workflow-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-workflow-template-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-create-workflow-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-update-workflow-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-step-definition-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-user-resource-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-subject-custom-attribute-definition-resource-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-membership-custom-attribute-definition-resource-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-group-custom-attribute-definition-resource-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-membership-resource-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-organization-list-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-audit-log-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-query-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-audit-query-result-audit-log-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-query-metadata-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-query-metadata-response-event-type-properties-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-invoice-item-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-invoice-list-item-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-organization-read-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-account-read-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-organization-create-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-organization-write-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-domain-read-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-get-metadata-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-domain-create-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-check-domain-availability-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-domain-patch-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-check-dns-setup-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-subscription-get-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-subscription-update-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-subscription-event-delivery-attempt-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-subscription-create-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-event-log-item-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-page-subscription-list-item-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-client-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-patch-client-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-public-key-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-signicat-error-template-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-secret-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-custom-claim-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-usage-set-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/signicat:signicat-changes-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

signicat-changes-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Signicat Changes API
  version: ''
  contact: ''
  license: ''
  termsOfService: ''
  x-meta: Custom metadata
  description: 'Operations tagged Changes across 2 of this provider''s published API definitions: ongoing-monitoring-person-openapi.json, signicat-ongoing-monitoring-person-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.signicat.com/info/monitor/person
tags:
- name: Changes
  description: Endpoint for retrieving person changes for a specific monitor.
paths:
  /monitors/{monitorId}/changes:
    get:
      tags:
      - Changes
      summary: Retrieve changes
      description: '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.'
      parameters:
      - name: monitorId
        in: path
        description: The monitor ID.
        required: true
        schema:
          type: string
      - name: offset
        in: query
        description: Optional cursor for pagination, which allows for paging without marking changes as read.
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: Optional parameter to set how many results you want per page.
        schema:
          type: integer
          format: int32
          default: 1000
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedCollection_1'
              example:
                offset: 0
                limit: 3
                size: 6
                links:
                  next: https://api.signicat.io/person-monitoring/monitors/4039/changes?limit=3&offset=3
                  first: https://api.signicat.io/person-monitoring/monitors/4039/changes
                data:
                - changeId: 1
                  status: ok
                  source: nationalRegistry
                  changeDetected: '2019-08-01T12:00:00.0Z'
                  referenceKey: c2690bae4cbc45b2a84e24de787b22d2
                - changeId: 15
                  status: invalid
                  source: nationalRegistry
                  changeDetected: '2019-08-01T12:00:00.0Z'
                  referenceKey: b25229e4f6024e35931e4edbe4a29009
                - changeId: 16
                  status: ok
                  source: nationalRegistry
                  changeDetected: '2019-10-01T12:00:00.0Z'
                  referenceKey: c2690bae4cbc45b2a84e24de787b22d2
                  changes:
                    firstName: Hedda Hansen
                    lastName: Tjolstad
                    address:
                      address: Åstadbakken 78
                      zipCode: '1341'
                      city: SLEPENDEN
                    screening:
                      riskLevel: 100
                      listType: SANCTION
                      source: EU_GLOBAL
                - changeId: 17
                  status: ok
                  source: nationalRegistry
                  changeDetected: '2019-10-01T12:00:00.0Z'
                  referenceKey: c2690bae4cbc45b2a84e24de787b22d2
                  changes:
                    firstName: Hedda Hansen
                    lastName: Tjolstad
                    isAddressProtected: true
                - changeId: 18
                  status: ok
                  source: nationalRegistry
                  changeDetected: '2019-10-01T12:00:00.0Z'
                  referenceKey: c2690bae4cbc45b2a84e24de787b22d2
                  changes:
                    isProtected: true
      operationId: getMonitorsByMonitorIdChanges
      x-operation-id-source: derived
    servers:
    - url: https://api.signicat.com/info/monitor/person
  /monitors/{monitorId}/changes/mark:
    post:
      tags:
      - Changes
      summary: Mark changes as read until the specified changeId
      description: Calling "Get Changes will retrieve all changes not marked as read
      parameters:
      - name: monitorId
        in: path
        description: The monitor ID.
        required: true
        schema:
          type: string
      - name: changeId
        in: query
        description: Set a cursor on the monitor so that only changes after the changeId are returned when querying for changes.
        schema:
          type: integer
          format: int32
      responses:
        '202':
          description: Accepted
      operationId: postMonitorsByMonitorIdChangesMark
      x-operation-id-source: derived
    servers:
    - url: https://api.signicat.com/info/monitor/person
  /monitors/{monitorId}/changes/mock:
    post:
      tags:
      - Changes
      summary: Mock changes
      description: '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.'
      parameters:
      - name: monitorId
        in: path
        description: The monitor ID.
        required: true
        schema:
          type: string
      requestBody:
        description: Changes that will be mocked.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MonitorMockChange'
            example:
              persons:
              - status: ok
                changeDetected: '2026-10-11T14:12:58.58Z'
                referenceKey: b25229e4f6024e35931e4edbe4a29009
                firstName: Hedda-Olai
                address:
                  address: Kirkegata 176
                isAddressProtected: false
                isProtected: false
              - status: ok
                changeDetected: '2026-10-11T14:12:58.58Z'
                referenceKey: b25229e4f6024e35931e4edbe4a29019
                firstName: Hedda-Olai
                isAddressProtected: true
                isProtected: false
              - status: ok
                changeDetected: '2026-10-11T14:12:58.58Z'
                referenceKey: b25229e4f6024e35931e4edbe4a29029
                isAddressProtected: false
                isProtected: true
              - status: ok
                changeDetected: '2026-10-11T14:12:58.58Z'
                referenceKey: b25229e4f6024e35931e4edbe4a29010
                isAddressProtected: false
                screening:
                  listType: PEP
                  source: PEP_Edge
                isProtected: false
              - status: invalid
                changeDetected: '2026-10-04T14:12:58.58Z'
                referenceKey: c2690bae4cbc45b2a84e24de787b22d2
                isAddressProtected: false
                isProtected: false
              source: nationalRegistry
      responses:
        '202':
          description: Mock data have been added for processing
        '403':
          description: Monitor doesn't allow mocking
      operationId: postMonitorsByMonitorIdChangesMock
      x-operation-id-source: derived
    servers:
    - url: https://api.signicat.com/info/monitor/person
  /monitors/{monitorId}/changes/persons/{referenceKey}:
    get:
      tags:
      - Changes
      summary: Retrieve changes for a person
      description: Retrieves all changes for a single person, ignoring any cursors.
      parameters:
      - name: monitorId
        in: path
        description: The monitor ID.
        required: true
        schema:
          type: string
      - name: referenceKey
        in: path
        description: The person's reference key.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The person was found
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PersonChanges'
              example:
              - changeId: 1
                status: ok
                source: nationalRegistry
                changeDetected: '2026-10-16T14:12:58.58Z'
                referenceKey: b25229e4f6024e35931e4edbe4a29009
                changes:
                  firstName: Anne
                  lastName: Olsen
                  middleName: Lise
                  dateOfBirth: '1997-10-18'
                  nationalIdentityNumber: '18109777441'
                  address:
                    address: Kveldstuavegen 32
                    zipCode: '9013'
                    city: Tromsø
                    country: 'NO'
                  screening:
                    riskLevel: 100
                    listType: SANCTION
                    source: EU_GLOBAL
              - changeId: 2
                status: ok
                source: nationalRegistry
                changeDetected: '2026-10-16T14:12:58.58Z'
                referenceKey: c2690bae4cbc45b2a84e24de787b22d2
                changes:
                  firstName: Anne
                  lastName: Olsen
                  middleName: Lise
                  dateOfBirth: '1997-10-18'
                  nationalIdentityNumber: '18109777441'
                  isAddressProtected: true
              - changeId: 3
                status: ok
                source: nationalRegistry
                changeDetected: '2026-10-16T14:12:58.58Z'
                referenceKey: c2690bae4cbc45b2a84e24de787b22d2
                changes:
                  isProtected: true
        '404':
          description: Monitor or person doesn't exist
      operationId: getMonitorsByMonitorIdChangesPersonsByReferenceKey
      x-operation-id-source: derived
    servers:
    - url: https://api.signicat.com/info/monitor/person
components:
  schemas:
    MonitorPersonStatus:
      enum:
      - unknown
      - ok
      - invalid
      type: string
      description: Status of the person
    PersonScreening:
      type: object
      properties:
        riskLevel:
          maximum: 5
          minimum: 1
          type:
          - integer
          - 'null'
          format: int32
        listType:
          maxLength: 200
          minLength: 1
          type:
          - string
          - 'null'
        source:
          maxLength: 200
          minLength: 1
          type:
          - string
          - 'null'
      additionalProperties: false
      description: Attribute providing information about the Screening status of the person
    MonitorPersonChange:
      type: object
      properties:
        firstName:
          type:
          - string
          - 'null'
          description: The person's new first name.
        lastName:
          type:
          - string
          - 'null'
          description: The person's new last name.
        middleName:
          type:
          - string
          - 'null'
          description: The person's new middle name, if available.
        dateOfBirth:
          type:
          - string
          - 'null'
          description: The person's new date of birth, if available.
          format: yyyy-MM-dd
          example: '2003-04-01'
        nationalIdentityNumber:
          type:
          - string
          - 'null'
          description: The person's new national identity number, if available.
        address:
          $ref: '#/components/schemas/PersonAddress'
        isAddressProtected:
          type:
          - boolean
          - 'null'
          description: Whether the person's address is protected
        isProtected:
          type:
          - boolean
          - 'null'
          description: Whether the person's information is protected
        screening:
          $ref: '#/components/schemas/PersonScreening'
        dateOfDeath:
          type:
          - string
          - 'null'
          description: The person's new date of death, if available.
          format: yyyy-MM-dd
          example: '2003-04-01'
      additionalProperties: false
      description: Relevant person changes. Only changed fields contain data.
    PersonChanges:
      type: object
      properties:
        changeId:
          type: integer
          description: Sequential ID of the change.
          format: int32
        status:
          $ref: '#/components/schemas/MonitorPersonStatus'
        source:
          $ref: '#/components/schemas/Source'
        changeDetected:
          type: string
          description: Date and time when the change was detected.
          format: date-time
        referenceKey:
          maxLength: 100
          minLength: 1
          type:
          - string
          - 'null'
          description: Person's reference key.
        changes:
          $ref: '#/components/schemas/MonitorPersonChange'
      additionalProperties: false
      description: ''
    PersonAddress:
      type: object
      properties:
        address:
          maxLength: 400
          minLength: 1
          type:
          - string
          - 'null'
          description: Address line.
        zipCode:
          maxLength: 20
          minLength: 1
          type:
          - string
          - 'null'
          description: Zip code / Postal code.
        city:
          maxLength: 200
          minLength: 1
          type:
          - string
          - 'null'
          description: City.
        country:
          maxLength: 3
          minLength: 2
          type:
          - string
          - 'null'
          description: Country (ISO 3166-1 alpha-2).
      additionalProperties: false
      description: The person's address
    Source:
      enum:
      - nationalRegistry
      - trapets
      type: string
      description: What kind of sources to use for monitoring
    PagedCollection_1:
      type: object
      properties:
        offset:
          type: integer
          description: The offset of the current page.
          format: int32
        limit:
          type: integer
          description: The limit of the current paging options.
          format: int32
        size:
          type: integer
          description: The total size of the collection (irrespective of any paging options).
          format: int64
        links:
          $ref: '#/components/schemas/Links'
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PersonChanges'
      additionalProperties: false
    Links:
      type: object
      properties:
        next:
          type:
          - string
          - 'null'
          description: Url of the next page
        previous:
          type:
          - string
          - 'null'
          description: Url of the previous page
        first:
          type:
          - string
          - 'null'
          description: Url of the first page
      additionalProperties: false
    MonitorMockPerson:
      required:
      - referenceKey
      type: object
      properties:
        status:
          $ref: '#/components/schemas/MonitorPersonStatus'
        changeDetected:
          type: string
          description: Date and time when the change was detected.
          format: date-time
        referenceKey:
          maxLength: 500
          minLength: 1
          type: string
          description: The person's reference key.
        nationalIdentityNumber:
          maxLength: 100
          minLength: 1
          type:
          - string
          - 'null'
          description: The person's national identity number.
        firstName:
          maxLength: 500
          minLength: 1
          type:
          - string
          - 'null'
          description: The person's first name.
        lastName:
          maxLength: 500
          minLength: 1
          type:
          - string
          - 'null'
          description: The person's last name.
        middleName:
          maxLength: 500
          minLength: 1
          type:
          - string
          - 'null'
          description: The person's middle name.
        address:
          $ref: '#/components/schemas/PersonAddress'
        isAddressProtected:
          type: boolean
          description: Whether the person's address is protected
        dateOfBirth:
          type:
          - string
          - 'null'
          description: The person's date of birth.
          format: yyyy-MM-dd
          example: '2003-04-01'
        dateOfDeath:
          type:
          - string
          - 'null'
          description: The person's date of death.
          format: yyyy-MM-dd
          example: '2003-04-01'
        screening:
          $ref: '#/components/schemas/PersonScreening'
        isProtected:
          type: boolean
          description: Whether the person's information is protected
      additionalProperties: false
      description: ''
    MonitorMockChange:
      required:
      - persons
      type: object
      properties:
        persons:
          maxItems: 1000000
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/MonitorMockPerson'
          description: List of person changes.
        source:
          $ref: '#/components/schemas/Source'
      additionalProperties: false
      description: ''
x-refined-from:
- ongoing-monitoring-person-openapi.json
- signicat-ongoing-monitoring-person-openapi.yml