Update AML Preference Settings

Request

Updates AML preferences for the current logged-in customer, Allows the customer to update AML preferences such as threshold, search type, action type, datasets, sanction bodies, and PEP tiers. Returns the updated preferences details.

Security

bearerToken

Bodyapplication/json

thresholdinteger, (int32)required

The threshold score value used for AML screening decisions. Higher values require stronger matches to trigger alerts.

searchTypestringrequired

The type of AML search to perform. Valid values are "individual" for person searches and "business" for company searches.

Enum:"individual""business"

searchActionTypestringrequired

The action type for the AML search. Valid values are "screening" for one-time checks and "monitoring" for ongoing surveillance.

Enum:"screening""monitoring"

pepTiersArray of strings

Array of PEP (Politically Exposed Person) tier classifications to include in AML screening. Valid values are pepTier1, pepTier2, pepTier3 and byAssociation.

Items Enum:"pepTier1""pepTier2""pepTier3""byAssociation"

datasetsArray of stringsrequired

Array of dataset names to include in the AML search. Specifies which data sources should be checked during screening.

sanctionBodiesArray of integers or null, (int32)

Array of sanction body IDs to include in the AML screening. May be null to use default sanction bodies or if not applicable.

isEmailRequiredboolean or null

Indicates whether email notifications are required for AML events and alerts. May be null to use system defaults.

emailRecipientsArray of strings or null

Array of email addresses to receive AML notifications and alerts. May be null if email notifications are disabled.

curl -i -X PUT \
  https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/settings/preferences/aml \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "threshold": 0,
    "searchType": "individual",
    "searchActionType": "screening",
    "pepTiers": [
      "pepTier1"
    ],
    "datasets": [
      "string"
    ],
    "sanctionBodies": [
      0
    ],
    "isEmailRequired": true,
    "emailRecipients": [
      "string"
    ]
  }'

Responses

Success

Bodyapplication/json

customerIdinteger, (int32)

The unique identifier for the customer associated with these AML settings.

searchTypestring

The type of AML search performed (e.g., screening, monitoring).

searchActionTypestring

The action type for the AML search (e.g., initial, update).

thresholdinteger, (int32)

The threshold value used for AML screening or monitoring decisions.

datasetsArray of strings

The list of datasets included in the AML search or monitoring process.

sanctionBodiesArray of integers or null, (int32)

The list of sanction body IDs used for AML screening. May be null if not set.

isEmailRequiredboolean or null

Indicates whether email notifications are required for AML events. May be null if not set.

emailRecipientsArray of strings or null

The list of email addresses to receive AML notifications. May be null if not set.

pepTiersArray of strings or null

The list of PEP (Politically Exposed Person) tiers included in the AML screening. May be null if not set.

createdAtstring or null, (date-time)

The date and time when these AML settings were created. May be null if not set.

createdByIdinteger or null, (int32)

The user ID of the person who created these AML settings. May be null if not set.

modifiedAtstring or null, (date-time)

The date and time when these AML settings were last modified. May be null if not set.

modifiedByIdinteger or null, (int32)

The user ID of the person who last modified these AML settings. May be null if not set.

correlationIdstring

A unique ID assigned to this request for tracking and troubleshooting purposes.

Response

{
  "customerId": 0,
  "searchType": "string",
  "searchActionType": "string",
  "threshold": 0,
  "datasets": [
    "string"
  ],
  "sanctionBodies": [
    0
  ],
  "isEmailRequired": true,
  "emailRecipients": [
    "string"
  ],
  "pepTiers": [
    "string"
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "createdById": 0,
  "modifiedAt": "2019-08-24T14:15:22Z",
  "modifiedById": 0,
  "correlationId": "string"
}