Update A Schedule In Monitoring

Updates a schedule in AML monitoring.

When there is a change in threshold or datasets, the system will deduct one credit for screening.

SecuritybearerToken
Request
path Parameters
scheduleId
required
string <uuid>

id of the profile

Request Body schema: application/json
threshold
integer <int32>

The threshold to use when running the schedule. Must be one of 75, 80, 85, 90, 95, 100. Changing threshold will cause even decided results to come back again and a new decision will need to be made.

datasets
Array of strings

The datasets to use when running the schedule. Changing datasets will cause even decided results to come back again and a new decision will need to be made.

Note: Please refer to the corresponding endpoint that the schedule is set against for the correct dataset options

isEmailRequired
boolean

Set to true to send an email when the schedule is run. If there are no email recipients set then this will be ignored.

emailRecipients
Array of strings

The list of email recipients to send the email to when the schedule is run. Email will not be sent if IsEmailRequired is false.

Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

put/compliance/kyc-protect/schedules/{scheduleId}
Request samples
application/json
{
  • "threshold": 0,
  • "datasets": [
    ],
  • "isEmailRequired": true,
  • "emailRecipients": [
    ]
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "searchId": "9b1a67f9-9477-48e5-8a6c-11b70245e1d9",
  • "isEmailRequired": true,
  • "emailRecipients": [
    ],
  • "createdById": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "modifiedById": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": "string",
  • "type": "string",
  • "name": "string",
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "gender": "string",
  • "dateOfBirth": "2019-08-24",
  • "countries": [
    ],
  • "threshold": 0,
  • "datasets": [
    ],
  • "pepTiers": [
    ],
  • "correlationId": "string"
}
➔ Next to Return All Hits For A Schedule By Created Date