logo

Retrieve AML settings

Retrieves AML settings.

SecuritySecretApiKey or JWT
Responses
200

AML settings retrieved.

Response Schema: application/json
object

Confidence level settings for AML matches.

object

Exact match of the customer's name is found, but a date of birth is not.

matchingCountry
string or null (AmlConfidence)

Degree of confidence to assign.

Enum: "weak" "medium" "strong" "very-strong"
mismatchingCountry
string or null (AmlConfidence)

Degree of confidence to assign.

Enum: "weak" "medium" "strong" "very-strong"
noCountry
string or null (AmlConfidence)

Degree of confidence to assign.

Enum: "weak" "medium" "strong" "very-strong"
object

Fuzzy, or inexact match of the customer's name is found, but a date of birth is not.

matchingCountry
string or null (AmlConfidence)

Degree of confidence to assign.

Enum: "weak" "medium" "strong" "very-strong"
mismatchingCountry
string or null (AmlConfidence)

Degree of confidence to assign.

Enum: "weak" "medium" "strong" "very-strong"
noCountry
string or null (AmlConfidence)

Degree of confidence to assign.

Enum: "weak" "medium" "strong" "very-strong"
object

Weak match of the customer's name is found, but a date of birth is not.

matchingCountry
string or null (AmlConfidence)

Degree of confidence to assign.

Enum: "weak" "medium" "strong" "very-strong"
mismatchingCountry
string or null (AmlConfidence)

Degree of confidence to assign.

Enum: "weak" "medium" "strong" "very-strong"
noCountry
string or null (AmlConfidence)

Degree of confidence to assign.

Enum: "weak" "medium" "strong" "very-strong"
object

Exact match of the customer's date of birth and name is found.

matchingCountry
string or null (AmlConfidence)

Degree of confidence to assign.

Enum: "weak" "medium" "strong" "very-strong"
mismatchingCountry
string or null (AmlConfidence)

Degree of confidence to assign.

Enum: "weak" "medium" "strong" "very-strong"
noCountry
string or null (AmlConfidence)

Degree of confidence to assign.

Enum: "weak" "medium" "strong" "very-strong"
object

Exact match of the customer's date of birth and a fuzzy, or inexact name match is found.

matchingCountry
string or null (AmlConfidence)

Degree of confidence to assign.

Enum: "weak" "medium" "strong" "very-strong"
mismatchingCountry
string or null (AmlConfidence)

Degree of confidence to assign.

Enum: "weak" "medium" "strong" "very-strong"
noCountry
string or null (AmlConfidence)

Degree of confidence to assign.

Enum: "weak" "medium" "strong" "very-strong"
object

Exact match of the customer's year of birth and exact name is found.

matchingCountry
string or null (AmlConfidence)

Degree of confidence to assign.

Enum: "weak" "medium" "strong" "very-strong"
mismatchingCountry
string or null (AmlConfidence)

Degree of confidence to assign.

Enum: "weak" "medium" "strong" "very-strong"
noCountry
string or null (AmlConfidence)

Degree of confidence to assign.

Enum: "weak" "medium" "strong" "very-strong"
object

Exact match of the customer's year of birth and a fuzzy, or inexact name match is found.

matchingCountry
string or null (AmlConfidence)

Degree of confidence to assign.

Enum: "weak" "medium" "strong" "very-strong"
mismatchingCountry
string or null (AmlConfidence)

Degree of confidence to assign.

Enum: "weak" "medium" "strong" "very-strong"
noCountry
string or null (AmlConfidence)

Degree of confidence to assign.

Enum: "weak" "medium" "strong" "very-strong"
object

Near match of the customer's year of birth and an exact name match is found.

matchingCountry
string or null (AmlConfidence)

Degree of confidence to assign.

Enum: "weak" "medium" "strong" "very-strong"
mismatchingCountry
string or null (AmlConfidence)

Degree of confidence to assign.

Enum: "weak" "medium" "strong" "very-strong"
noCountry
string or null (AmlConfidence)

Degree of confidence to assign.

Enum: "weak" "medium" "strong" "very-strong"
object

Near match of the customer's year of birth and a fuzzy, or inexact name match is found.

matchingCountry
string or null (AmlConfidence)

Degree of confidence to assign.

Enum: "weak" "medium" "strong" "very-strong"
mismatchingCountry
string or null (AmlConfidence)

Degree of confidence to assign.

Enum: "weak" "medium" "strong" "very-strong"
noCountry
string or null (AmlConfidence)

Degree of confidence to assign.

Enum: "weak" "medium" "strong" "very-strong"
object

Priority level settings for AML source matches.
p0 is critical priority level, and p3 is low priority level.

object

Priorities for the pep source type.

veryStrong
string or null (AmlPriority)
Default: null

Priority level of matched AML customer information.

Enum: "p0" "p1" "p2" "p3"
strong
string or null (AmlPriority)
Default: null

Priority level of matched AML customer information.

Enum: "p0" "p1" "p2" "p3"
medium
string or null (AmlPriority)
Default: null

Priority level of matched AML customer information.

Enum: "p0" "p1" "p2" "p3"
weak
string or null (AmlPriority)
Default: null

Priority level of matched AML customer information.

Enum: "p0" "p1" "p2" "p3"
object

Priorities for the enforcement source type.

veryStrong
string or null (AmlPriority)
Default: null

Priority level of matched AML customer information.

Enum: "p0" "p1" "p2" "p3"
strong
string or null (AmlPriority)
Default: null

Priority level of matched AML customer information.

Enum: "p0" "p1" "p2" "p3"
medium
string or null (AmlPriority)
Default: null

Priority level of matched AML customer information.

Enum: "p0" "p1" "p2" "p3"
weak
string or null (AmlPriority)
Default: null

Priority level of matched AML customer information.

Enum: "p0" "p1" "p2" "p3"
object

Priorities for the state-owned-enterprise source type.

veryStrong
string or null (AmlPriority)
Default: null

Priority level of matched AML customer information.

Enum: "p0" "p1" "p2" "p3"
strong
string or null (AmlPriority)
Default: null

Priority level of matched AML customer information.

Enum: "p0" "p1" "p2" "p3"
medium
string or null (AmlPriority)
Default: null

Priority level of matched AML customer information.

Enum: "p0" "p1" "p2" "p3"
weak
string or null (AmlPriority)
Default: null

Priority level of matched AML customer information.

Enum: "p0" "p1" "p2" "p3"
object

Priorities for the sanctions source type.

veryStrong
string or null (AmlPriority)
Default: null

Priority level of matched AML customer information.

Enum: "p0" "p1" "p2" "p3"
strong
string or null (AmlPriority)
Default: null

Priority level of matched AML customer information.

Enum: "p0" "p1" "p2" "p3"
medium
string or null (AmlPriority)
Default: null

Priority level of matched AML customer information.

Enum: "p0" "p1" "p2" "p3"
weak
string or null (AmlPriority)
Default: null

Priority level of matched AML customer information.

Enum: "p0" "p1" "p2" "p3"
object

Priorities for the adverse-media source type.

veryStrong
string or null (AmlPriority)
Default: null

Priority level of matched AML customer information.

Enum: "p0" "p1" "p2" "p3"
strong
string or null (AmlPriority)
Default: null

Priority level of matched AML customer information.

Enum: "p0" "p1" "p2" "p3"
medium
string or null (AmlPriority)
Default: null

Priority level of matched AML customer information.

Enum: "p0" "p1" "p2" "p3"
weak
string or null (AmlPriority)
Default: null

Priority level of matched AML customer information.

Enum: "p0" "p1" "p2" "p3"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/aml-settings
Request samples 
Response samples 
application/json
{
  • "confidence": {
    },
  • "priority": {
    }
}
➔ Next to Update AML settings