Versions Compared

Version Old Version 1 New Version 2
Changes made by

Pavelas Bulatovas (Deactivated)

Pavelas Bulatovas (Deactivated)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Person

Add a record to monitoring worklist

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

🧑‍🦱 🧑 🧑‍🦱 Add multiple persons to the monitoring worklist

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

Panel
bgColor#FFBDAD

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

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

Request data

Name

Description

Mandatory/Optional

1

id

The unique Id of monitored person set by the user.

Status
colourRed
titleMANDATORY

2

name

The full name of the person to be monitored.

Status
colourRed
titleMANDATORY

3

countries

The list of countries related to person in ISO2 format.

Status
colourRed
titleMANDATORY

4

dob

Person’s date of birth in ISO format YYYY-MM-DD.

Status
colourGreen
titleOPTIONAL

5

gender

Possible enum values:

  1. male

  2. female

Status
colourGreen
titleOPTIONAL

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

Name

Description

1

hasErrors

Indicates if any of processed records has erros.

2

results

The array with status codes of added records.

3

results.statusCode

The status code of record.

4

results.error

Object with information about errors.

5

results.error.code

Error identifier.

6

results.error.message

Error description.

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

Panel
bgColor#FFBDAD

PUT /worklists/{worklistId}/individuals/{monitorRecordId} - add/update single person, providing it’s Id.

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

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

Request data

Name

Description

Mandatory/Optional

1

name

The full name of the person to be monitored.

Status
colourRed
titleMANDATORY

2

countries

The list of countries related to person in ISO2 format.

Status
colourRed
titleMANDATORY

3

dob

Person’s date of birth in ISO format YYYY-MM-DD.

Status
colourGreen
titleOPTIONAL

4

gender

Possible enum values:

  1. male

  2. female

Status
colourGreen
titleOPTIONAL

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

Retrieve monitoring record

Delete monitoring record

...

Business

Add a record to monitoring worklist

Once monitoring rules are set up, you can add 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

1

id

The unique Id of monitored business set by the user.

Status
colourRed
titleMANDATORY

2

name

The full name of the business to be monitored.

Status
colourRed
titleMANDATORY

3

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.

🏢 Add a single business to the monitoring worklist

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

1

name

The full name of the business to be monitored.

Status
colourRed
titleMANDATORY

2

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

Delete monitoring record