Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 5 Next »

Add a person to monitoring

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:

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

Request data

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

Name

Description

Mandatory/Optional

1

id

The unique Id of monitored person set by the user.

MANDATORY

2

name

The full name of the person to be monitored.

MANDATORY

3

countries

The list of countries related to person in ISO2 format.

MANDATORY

4

dob

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

OPTIONAL

5

gender

Possible enum values:

  1. male

  2. female

OPTIONAL

🗒️ Example
 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:

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
 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:

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

Request data

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

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

Name

Description

Mandatory/Optional

1

name

The full name of the person to be monitored.

MANDATORY

2

countries

The list of countries related to person in ISO2 format.

MANDATORY

3

dob

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

OPTIONAL

4

gender

Possible enum values:

  1. male

  2. female

OPTIONAL

🗒️ Example
 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 :

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

or

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

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:

Current

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

Updated

{
  "monitorRecords": [
    {
      "id": "HighRiskProfile300",
      "name": "Alan Alanavicius",
      "countries": [
        "US", "LT"
      ],
      "dob": "1994-10-11"
    }
  ]
}

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:

Current

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

Updated

{
  "name": "Alan Alanavicius",
  "countries": [
    "US", "LT"
  ],
  "dob": "1991"
}

Response data

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

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:

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.

MANDATORY

2

name

The full name of the business to be monitored.

MANDATORY

3

countries

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

MANDATORY

🗒️ Example
 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:

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.

MANDATORY

2

countries

The list of countries related to business in ISO2 format.

MANDATORY

🗒️ Example
 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

  • No labels