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

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

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

Panel
bgColor#FFBDAD

PUT /worklists/{worklistId}/businesses - add/update multiple businesses, up to 25.

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

Request data

Name

...

Description

...

Mandatory/Optional

...

id

...

The unique Id of monitored business set by the user.

...

Status
colourRed
titleMANDATORY

...

name

...

The full name of the business to be monitored.

...

Status
colourRed
titleMANDATORY

...

countries

...

The list of countries related to the business in ISO2 format.

...

Status
colourRed
titleMANDATORY

🗒️ Example
Expand
titleExample
Code Block
languagejson
{
  "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.

...

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

Panel
bgColor#FFBDAD

PUT /worklists/{worklistId}/businesses/{monitorRecordId} - add/update single business, providing it's Id.

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

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

Request data

Name

...

Description

...

Mandatory/Optional

...

name

...

The full name of the business to be monitored.

...

Status
colourRed
titleMANDATORY

...

countries

...

The list of countries related to business in ISO2 format.

...

Status
colourRed
titleMANDATORY

🗒️ Example
Expand
titleExample
Code Block
languagejson
{
  "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

...