# Retrieve AML settings

Retrieves AML settings.

Endpoint: GET /aml-settings
Version: latest
Security: SecretApiKey, JWT

## Response 200 fields (application/json):

  - `confidence` (object)
    Confidence level settings for AML matches.

  - `confidence.dob` (object)
    Confidence level settings for AML matches based on date of birth.

  - `confidence.dob.exactMatch` (object)
    Exact match of the customer's date of birth and name is found.

  - `confidence.dob.exactMatch.addressMatch` (object)
    Match for the customer's city or region, or both, is found.

  - `confidence.dob.exactMatch.addressMatch.matchingCountry` (string,null)
    Degree of confidence to assign.
    Enum: "weak", "medium", "strong", "very-strong"

  - `confidence.dob.exactMatch.addressMatch.mismatchingCountry` (string,null)
    Degree of confidence to assign.
    Enum: same as `confidence.dob.exactMatch.addressMatch.matchingCountry` (4 values)

  - `confidence.dob.exactMatch.addressMatch.noCountry` (string,null)
    Degree of confidence to assign.
    Enum: same as `confidence.dob.exactMatch.addressMatch.matchingCountry` (4 values)

  - `confidence.dob.exactMatch.addressMismatch` (object)
    Match for the customer's city or region, or both, is not found.

  - `confidence.dob.exactMatch.addressMismatch.matchingCountry` (string,null)
    Degree of confidence to assign.
    Enum: same as `confidence.dob.exactMatch.addressMatch.matchingCountry` (4 values)

  - `confidence.dob.exactMatch.addressMismatch.mismatchingCountry` (string,null)
    Degree of confidence to assign.
    Enum: same as `confidence.dob.exactMatch.addressMatch.matchingCountry` (4 values)

  - `confidence.dob.exactMatch.addressMismatch.noCountry` (string,null)
    Degree of confidence to assign.
    Enum: same as `confidence.dob.exactMatch.addressMatch.matchingCountry` (4 values)

  - `confidence.dob.exactMatch.noAddress` (object)
    No city and no region is available to match against.

  - `confidence.dob.exactMatch.noAddress.matchingCountry` (string,null)
    Degree of confidence to assign.
    Enum: same as `confidence.dob.exactMatch.addressMatch.matchingCountry` (4 values)

  - `confidence.dob.exactMatch.noAddress.mismatchingCountry` (string,null)
    Degree of confidence to assign.
    Enum: same as `confidence.dob.exactMatch.addressMatch.matchingCountry` (4 values)

  - `confidence.dob.exactMatch.noAddress.noCountry` (string,null)
    Degree of confidence to assign.
    Enum: same as `confidence.dob.exactMatch.addressMatch.matchingCountry` (4 values)

  - `confidence.dob.inexactMatch` (object)
    Exact match of the customer's date of birth and a fuzzy, or inexact, name match is found.

  - `confidence.noDob` (object)
    Confidence level settings for AML matches based on a missing date of birth.

  - `confidence.noDob.exactMatch` (object)
    Exact match of the customer's name is found, but a date of birth is not.

  - `confidence.noDob.inexactMatch` (object)
    Fuzzy, or inexact match of the customer's name is found, but a date of birth is not.

  - `confidence.noDob.weakMatch` (object)
    Weak match of the customer's name is found, but a date of birth is not.

  - `confidence.yob` (object)
    Confidence level settings for AML matches based on year of birth.

  - `confidence.yob.exactMatch` (object)
    Exact match of the customer's year of birth and exact name is found.

  - `confidence.yob.inexactMatch` (object)
    Exact match of the customer's year of birth and a fuzzy, or inexact, name match is found.

  - `confidence.inexactYob` (object)
    Confidence level settings for AML matches based on a near match of year of birth.

  - `confidence.inexactYob.exactMatch` (object)
    Near match of the customer's year of birth and an exact name match is found.

  - `confidence.inexactYob.inexactMatch` (object)
    Near match of the customer's year of birth and a fuzzy, or inexact, name match is found.

  - `priority` (object)
    Priority level settings for AML source matches. \
p0 is critical priority level, and p3 is low priority level.

  - `priority.pep` (object)
    Priorities for the pep source type.

  - `priority.pep.veryStrong` (string,null)
    Priority level of matched AML customer information.
    Enum: "p0", "p1", "p2", "p3"

  - `priority.pep.strong` (string,null)
    Priority level of matched AML customer information.
    Enum: same as `priority.pep.veryStrong` (4 values)

  - `priority.pep.medium` (string,null)
    Priority level of matched AML customer information.
    Enum: same as `priority.pep.veryStrong` (4 values)

  - `priority.pep.weak` (string,null)
    Priority level of matched AML customer information.
    Enum: same as `priority.pep.veryStrong` (4 values)

  - `priority.enforcements` (object)
    Priorities for the enforcement source type.

  - `priority.enforcements.veryStrong` (string,null)
    Priority level of matched AML customer information.
    Enum: same as `priority.pep.veryStrong` (4 values)

  - `priority.enforcements.strong` (string,null)
    Priority level of matched AML customer information.
    Enum: same as `priority.pep.veryStrong` (4 values)

  - `priority.enforcements.medium` (string,null)
    Priority level of matched AML customer information.
    Enum: same as `priority.pep.veryStrong` (4 values)

  - `priority.enforcements.weak` (string,null)
    Priority level of matched AML customer information.
    Enum: same as `priority.pep.veryStrong` (4 values)

  - `priority.stateOwnedEnterprise` (object)
    Priorities for the state-owned-enterprise source type.

  - `priority.stateOwnedEnterprise.veryStrong` (string,null)
    Priority level of matched AML customer information.
    Enum: same as `priority.pep.veryStrong` (4 values)

  - `priority.stateOwnedEnterprise.strong` (string,null)
    Priority level of matched AML customer information.
    Enum: same as `priority.pep.veryStrong` (4 values)

  - `priority.stateOwnedEnterprise.medium` (string,null)
    Priority level of matched AML customer information.
    Enum: same as `priority.pep.veryStrong` (4 values)

  - `priority.stateOwnedEnterprise.weak` (string,null)
    Priority level of matched AML customer information.
    Enum: same as `priority.pep.veryStrong` (4 values)

  - `priority.sanctions` (object)
    Priorities for the sanctions source type.

  - `priority.sanctions.veryStrong` (string,null)
    Priority level of matched AML customer information.
    Enum: same as `priority.pep.veryStrong` (4 values)

  - `priority.sanctions.strong` (string,null)
    Priority level of matched AML customer information.
    Enum: same as `priority.pep.veryStrong` (4 values)

  - `priority.sanctions.medium` (string,null)
    Priority level of matched AML customer information.
    Enum: same as `priority.pep.veryStrong` (4 values)

  - `priority.sanctions.weak` (string,null)
    Priority level of matched AML customer information.
    Enum: same as `priority.pep.veryStrong` (4 values)

  - `priority.adverseMedia` (object)
    Priorities for the adverse-media source type.

  - `priority.adverseMedia.veryStrong` (string,null)
    Priority level of matched AML customer information.
    Enum: same as `priority.pep.veryStrong` (4 values)

  - `priority.adverseMedia.strong` (string,null)
    Priority level of matched AML customer information.
    Enum: same as `priority.pep.veryStrong` (4 values)

  - `priority.adverseMedia.medium` (string,null)
    Priority level of matched AML customer information.
    Enum: same as `priority.pep.veryStrong` (4 values)

  - `priority.adverseMedia.weak` (string,null)
    Priority level of matched AML customer information.
    Enum: same as `priority.pep.veryStrong` (4 values)

## Response 401 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 403 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 404 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.