Once monitoring rules in the worklist are set up, you can add a person(-s) or business (-es) to the monitoring worklist.

• Person monitoring

• Business monitoring

Add a person to monitoring

Add multiple persons to the monitoring worklist

If you want to add several persons to monitoring, call the following endpoint:

Request data

{worklistId} - worklist Id, into which persons will be added.

🗒️ Example

{
  "monitorRecords": [
    {
      "id": "HighRiskProfile300",
      "name": "Boyko Borissov",
      "countries": [
        "US"
      ],
      "dob": "1994-08-22",
      "gender": "male"
    }
  ]
}

Response data

In the response, you’ll get the results array with status codes:

🗒️ Example

{
  "hasErrors": true,
  "results": [
    {
      "statusCode": 200
    },
    {
      "statusCode": 201
    },
    {
      "statusCode": 400,
      "error": {
        "code": "MAPI-005",
        "message": "Invalid type of attribute countries."
      }
    },
    {
      "statusCode": 409,
      "error": {
        "code": "MAPI-011",
        "message": "ID is temporarily blocked or ID is temporarily invalid"
      }
    }
  ]
}

🧑‍🦱 Add a single person to the monitoring worklist

If you want to add a single person to monitoring, call the following endpoint:

Request data

{worklistId} - worklist Id, into which persons will be added.

{monitorRecordId} - the unique Id of the person, who will be monitored.

🗒️ Example

{
  "name": "Boyko Borissov",
  "countries": [
    "US"
  ],
  "dob": "1994-08-22",
  "gender": "male"
}

Response data

After successfully adding a person(-s) to the monitoring worklist you’ll get a response with success code 201: Created.

Update monitoring record

The monitored person can be updated by calling the same endpoints as for adding a person to monitoring :

or

Update multiple persons record

Request data

In query parameter {worklistId} pass Id of the worklist inside which persons will be updated.

The request structure is the same as for adding to monitoring. You can change the current values of a particular field by providing new ones:

Response data

After successfully updating multiple persons monitoring records you’ll get the same response as for adding persons to monitoring, described here.

Update a single person record

Request data

• In query parameter {worklistId} pass Id of the worklist inside which persons will be updated.

• In query parameter {monitorRecordId} pass Id of the person who will be updated.

The request structure is the same as for adding to monitoring. You can change the current values of a particular field by providing new ones:

Response data

After successfully updating a single person monitoring record you’ll get the response with success code 200: Ok.

Retrieve monitoring record

Specific person by Id

To retrieve a specific person, call the endpoint:

Request data

{worklistId} - Id of the worklist you want to retrieve.

{monitorRecordId} - the unique Id of the person, who will be retrieved.

Response data

🗒️ Example

{
  "name": "Boyko Borissov",
  "countries": [
    "US"
  ],
  "dob": "1994-08-22",
  "gender": "male",
  "id": "ABC4043",
  "openCount": 1,
  "falsePositiveCount": 0,
  "truePositiveCount": 0,
  "discardedCount": 0,
  "createdDateTimeISO": "2021-10-05T10:10:08.270Z",
  "lastUpdatedDateTimeISO": "2021-10-05T10:10:08.270Z"
}

All persons

To retrieve all persons, call the endpoint:

Request data

{worklistId} - Id of the worklist from which persons will be retrieved.

Response data

🗒️ Example

{
  "monitorRecords": [
    {
      "name": "Boyko Borissov",
      "countries": [
        "US"
      ],
      "dob": "1994-08-22",
      "gender": "male",
      "id": "ABC4043",
      "openCount": 1,
      "falsePositiveCount": 0,
      "truePositiveCount": 0,
      "discardedCount": 0,
      "createdDateTimeISO": "2021-10-05T10:10:08.270Z",
      "lastUpdatedDateTimeISO": "2021-10-05T10:10:08.270Z"
    }
  ],
  "monitorRecordsCount": 5,
  "openMonitorRecordsCount": 1,
  "openMatchesCount": 3,
  "falsePositiveMatchesCount": 3,
  "truePositiveMatchesCount": 1,
  "discardedMatchesCount": 1,
  "nextToken": "ZGggZiBkZ2hqIDQ1IDU0eSBleSBlciBlcnQgZXlyIHJldA=="
}

Delete monitoring record

To delete a person from monitoring, call the endpoint:

Request data

• In query parameter {worklistId} pass Id of the worklist in which the person you want to delete is.

• In query parameter {monitorRecordId} pass Id of the person you want to delete.

Response data

After successfully deleting a person you’ll get a response with success code 200: Ok.

Business

🏛️ 🏢 🏘️ Add multiple businesses to the monitoring worklist

If you want to add several businesses to monitoring, call the following endpoint:

{worklistId} - worklist Id, into which businesses will be added.

Request data

🗒️ Example

{
  "monitorRecords": [
    {
      "id": "HighRiskProfile300",
      "name": "IBM Corporation",
      "countries": [
        "US"
      ]
    }
  ]
}

Response data

In the response, you’ll get the results array with status codes, the same as for persons.

🏢 Add a single business to the monitoring worklist

If you want to add a single business to monitoring, call the following endpoint:

{worklistId} - worklist Id, into which persons will be added.

{monitorRecordId} - the unique Id of the business, who will be monitored.

Request data

🗒️ Example

{
  "name": "IBM Corporation",
  "countries": [
    "US"
  ]
}

Response data

After successfully adding a business to the monitoring worklist you’ll get a response with success code 201: Created.

Update monitoring record

Retrieve monitoring record

Delete monitoring record