Return AML Preference Settings

Request

Returns AML preferences for the current logged-in customer,Fetches the AML preferences configured for the current customer, filtered by search type and action type.

Security

bearerToken

Query

searchTypestringrequired

The search type: 'individual' or 'business'

Enum:"individual""business"

searchActionTypestringrequired

The search action type: 'screening' or 'monitoring'

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/settings/preferences/aml?searchType=individual&searchActionType=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

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"
}