# Add Search To AML Monitoring

Adds the specified searches to AML monitoring, i.e. schedules them for screening. If thresholds and datasets are amended from the original search, new results will generated. Any existing hits will be overridden and any previous match decisions will be reset.   A pre-requisite for monitoring work is that any searches MUST be linked to a profile before Monitoring can be Active.

Endpoint: POST /compliance/kyc-protect/schedules
Version: 1.10.9
Security: bearerToken

## Request fields (application/json):

  - `items` (array)

  - `items.threshold` (integer)
    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.

  - `items.datasets` (array)
    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.

  - `items.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.

  - `items.emailRecipients` (array,null)
    The list of email recipients to send the email to when the schedule is run. Email will not be sent if IsEmailRequired is false.

  - `items.searchId` (string)
    The id of the search to be scheduled

  - `items.isDobRequired` (boolean,null)
    IsDobRequired is optional field and default value is false, valid along with dob only.

## Response 200 fields (application/json):

  - `failed` (array)

  - `failed.failedItem` (object)

  - `failed.failedItem.threshold` (integer)
    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.

  - `failed.failedItem.datasets` (array)
    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.

  - `failed.failedItem.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.

  - `failed.failedItem.emailRecipients` (array,null)
    The list of email recipients to send the email to when the schedule is run. Email will not be sent if IsEmailRequired is false.

  - `failed.failedItem.searchId` (string)
    The id of the search to be scheduled

  - `failed.failedItem.isDobRequired` (boolean,null)
    IsDobRequired is optional field and default value is false, valid along with dob only.

  - `failed.error` (object)

  - `failed.error.type` (string)

  - `failed.error.title` (string)

  - `failed.error.status` (number)

  - `failed.error.detail` (string)

  - `failed.error.instance` (string)

  - `failed.error.additionalProp1` (string)

  - `failed.error.additionalProp2` (string)

  - `failed.error.additionalProp3` (string)

  - `successful` (array)

  - `successful.items` (array)

  - `successful.items.id` (string)
    The id of the schedule

  - `successful.items.searchId` (string)
    The id of the search that was being scheduled

  - `successful.items.isEmailRequired` (boolean)
    Indicates whether the schedule requires an email to be sent when the search is run

  - `successful.items.emailRecipients` (array)
    The email recipients that the email should be sent to when the search is run

  - `successful.items.createdById` (integer)
    The id of the user who created the schedule

  - `successful.items.createdAt` (string)
    The time the schedule was created

  - `successful.items.createdBy` (string)
    The name of the user who created the schedule

  - `successful.items.modifiedById` (integer)
    The id of the user who last modified the schedule

  - `successful.items.modifiedAt` (string)
    The time the schedule was last modified

  - `successful.items.modifiedBy` (string)
    The name of the user who last modified the schedule

  - `successful.items.type` (string)
    The type of the schedule, i.e. business or individual

  - `successful.items.name` (string)
    The name used in the search criteria

  - `successful.items.firstName` (string)
    The first name used in the search criteria

  - `successful.items.middleName` (string)
    The middle name used in the search criteria

  - `successful.items.lastName` (string)
    The last name used in the search criteria

  - `successful.items.gender` (string)
    The gender used in the search criteria, i.e. male or female

  - `successful.items.dateOfBirth` (string)
    The date of birth used in the search criteria

  - `successful.items.countries` (array)
    The list of country codes used in the search criteria

  - `successful.items.threshold` (integer)
    The threshold used in the search criteria

  - `successful.items.datasets` (array)
    The datasets used in the search criteria

  - `successful.items.pepTiers` (array)
    The pep tiers used in the search criteria

  - `successful.items.isDobRequired` (boolean,null)
    Indicates whether date of birth is required for the individual search.

  - `successful.totalSize` (number)

## Response 400 fields (application/json):

  - `correlationId` (string)
    A unique ID assigned to this request.

  - `message` (string)

  - `details` (string)
    Provides further information on why the request was rejected

## Response 401 fields (application/json):

  - `error` (string)

## Response 403 fields (application/json):

  - `message` (string)
    Example: "Access forbidden"