# Update AML settings

Updates AML settings.

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

## Security:

  - `SecretApiKey` (unknown)
    apiKey in header REB-APIKEY

  - `JWT` (unknown)
    http bearer JWT

## Request body:

  - `application/json` (unknown)
    Settings for AML searches.

## Request 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)

  - `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.addressMismatch` (object)
    Match for the customer's city or region, or both, is not found.

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

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

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

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

  - `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.enforcements` (object)
    Priorities for the `enforcement` source type.

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

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

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

## Response 200:

  - `200` (unknown)
    AML settings updated.

## 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)

  - `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.addressMismatch` (object)
    Match for the customer's city or region, or both, is not found.

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

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

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

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

  - `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.enforcements` (object)
    Priorities for the `enforcement` source type.

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

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

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

## Response 200 headers (application/json):

  - `X-RateLimit-Limit` (integer)
    Total number of rate limit tokens for this request within a rate limit period.
For more information, see [Rate limits](#section/Rate-limits).
    Example: 3600

  - `X-RateLimit-Remaining` (integer)
    Remaining number of rate limit tokens for this request within the rate limit period. 
For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.
    Example: 3600

## Response 201:

  - `201` (unknown)
    AML settings created.

## Response 201 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)

  - `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.addressMismatch` (object)
    Match for the customer's city or region, or both, is not found.

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

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

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

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

  - `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.enforcements` (object)
    Priorities for the `enforcement` source type.

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

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

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

## Response 201 headers (application/json):

  - `Location` (string)
    Location of the related resource.
    Example: https://api.rebilly.com/example

  - `X-RateLimit-Limit` (integer)
    Total number of rate limit tokens for this request within a rate limit period.
For more information, see [Rate limits](#section/Rate-limits).
    Example: 3600

  - `X-RateLimit-Remaining` (integer)
    Remaining number of rate limit tokens for this request within the rate limit period. 
For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.
    Example: 3600

## Response 401:

  - `401` (unknown)
    Unauthorized access.
Invalid credentials used.

## 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:

  - `403` (unknown)
    Access forbidden.

## 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:

  - `404` (unknown)
    Resource not found.

## 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.

## Response 429:

  - `429` (unknown)
    Request rate limit exceeded.

## Response 429 fields (application/json):

  - `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".
    Example: 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.
    Example: Rate Limit Exceeded

  - `status` (integer)
    HTTP status code.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.
    Example: A request cannot be executed because the user has sent too many requests within a certain period of time

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

## Response 429 headers (application/json):

  - `X-RateLimit-Retry-After` (integer)
    UTC timestamp after which the rate limit resets and the request can be retried.
    Example: 1713187500