PUT /aml-settings
Updates AML settings.
Servers
- https://api-sandbox.rebilly.com/organizations/{organizationId}
- https://api.rebilly.com/organizations/{organizationId}
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
priority |
Object | No |
Priority level settings for AML source matches. |
priority.sanctions |
Object | No |
Priorities for the |
priority.sanctions.medium |
String | No |
Priority level of matched AML customer information. Valid values:
|
priority.sanctions.strong |
String | No |
Priority level of matched AML customer information. Valid values:
|
priority.sanctions.weak |
String | No |
Priority level of matched AML customer information. Valid values:
|
priority.sanctions.veryStrong |
String | No |
Priority level of matched AML customer information. Valid values:
|
priority.adverseMedia |
Object | No |
Priorities for the |
priority.adverseMedia.medium |
String | No |
Priority level of matched AML customer information. Valid values:
|
priority.adverseMedia.strong |
String | No |
Priority level of matched AML customer information. Valid values:
|
priority.adverseMedia.weak |
String | No |
Priority level of matched AML customer information. Valid values:
|
priority.adverseMedia.veryStrong |
String | No |
Priority level of matched AML customer information. Valid values:
|
priority.pep |
Object | No |
Priorities for the |
priority.pep.medium |
String | No |
Priority level of matched AML customer information. Valid values:
|
priority.pep.strong |
String | No |
Priority level of matched AML customer information. Valid values:
|
priority.pep.weak |
String | No |
Priority level of matched AML customer information. Valid values:
|
priority.pep.veryStrong |
String | No |
Priority level of matched AML customer information. Valid values:
|
priority.stateOwnedEnterprise |
Object | No |
Priorities for the |
priority.stateOwnedEnterprise.medium |
String | No |
Priority level of matched AML customer information. Valid values:
|
priority.stateOwnedEnterprise.strong |
String | No |
Priority level of matched AML customer information. Valid values:
|
priority.stateOwnedEnterprise.weak |
String | No |
Priority level of matched AML customer information. Valid values:
|
priority.stateOwnedEnterprise.veryStrong |
String | No |
Priority level of matched AML customer information. Valid values:
|
priority.enforcements |
Object | No |
Priorities for the |
priority.enforcements.medium |
String | No |
Priority level of matched AML customer information. Valid values:
|
priority.enforcements.strong |
String | No |
Priority level of matched AML customer information. Valid values:
|
priority.enforcements.weak |
String | No |
Priority level of matched AML customer information. Valid values:
|
priority.enforcements.veryStrong |
String | No |
Priority level of matched AML customer information. Valid values:
|
confidence |
Object | No |
Confidence level settings for AML matches. |
confidence.yob |
Object | No |
Confidence level settings for AML matches based on year of birth. |
confidence.yob.inexactMatch |
Object | No |
Exact match of the customer's year of birth and a fuzzy, or inexact, name match is found. |
confidence.yob.inexactMatch.noAddress |
Object | No |
No city and no region is available to match against. |
confidence.yob.inexactMatch.noAddress.noCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.yob.inexactMatch.noAddress.mismatchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.yob.inexactMatch.noAddress.matchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.yob.inexactMatch.addressMatch |
Object | No |
Match for the customer's city or region, or both, is found. |
confidence.yob.inexactMatch.addressMatch.noCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.yob.inexactMatch.addressMatch.mismatchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.yob.inexactMatch.addressMatch.matchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.yob.inexactMatch.addressMismatch |
Object | No |
Match for the customer's city or region, or both, is not found. |
confidence.yob.inexactMatch.addressMismatch.noCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.yob.inexactMatch.addressMismatch.mismatchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.yob.inexactMatch.addressMismatch.matchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.yob.exactMatch |
Object | No |
Exact match of the customer's year of birth and exact name is found. |
confidence.yob.exactMatch.noAddress |
Object | No |
No city and no region is available to match against. |
confidence.yob.exactMatch.noAddress.noCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.yob.exactMatch.noAddress.mismatchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.yob.exactMatch.noAddress.matchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.yob.exactMatch.addressMatch |
Object | No |
Match for the customer's city or region, or both, is found. |
confidence.yob.exactMatch.addressMatch.noCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.yob.exactMatch.addressMatch.mismatchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.yob.exactMatch.addressMatch.matchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.yob.exactMatch.addressMismatch |
Object | No |
Match for the customer's city or region, or both, is not found. |
confidence.yob.exactMatch.addressMismatch.noCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.yob.exactMatch.addressMismatch.mismatchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.yob.exactMatch.addressMismatch.matchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.noDob |
Object | No |
Confidence level settings for AML matches based on a missing date of birth. |
confidence.noDob.weakMatch |
Object | No |
Weak match of the customer's name is found, but a date of birth is not. |
confidence.noDob.weakMatch.noAddress |
Object | No |
No city and no region is available to match against. |
confidence.noDob.weakMatch.noAddress.noCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.noDob.weakMatch.noAddress.mismatchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.noDob.weakMatch.noAddress.matchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.noDob.weakMatch.addressMatch |
Object | No |
Match for the customer's city or region, or both, is found. |
confidence.noDob.weakMatch.addressMatch.noCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.noDob.weakMatch.addressMatch.mismatchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.noDob.weakMatch.addressMatch.matchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.noDob.weakMatch.addressMismatch |
Object | No |
Match for the customer's city or region, or both, is not found. |
confidence.noDob.weakMatch.addressMismatch.noCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.noDob.weakMatch.addressMismatch.mismatchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.noDob.weakMatch.addressMismatch.matchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.noDob.inexactMatch |
Object | No |
Fuzzy, or inexact match of the customer's name is found, but a date of birth is not. |
confidence.noDob.inexactMatch.noAddress |
Object | No |
No city and no region is available to match against. |
confidence.noDob.inexactMatch.noAddress.noCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.noDob.inexactMatch.noAddress.mismatchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.noDob.inexactMatch.noAddress.matchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.noDob.inexactMatch.addressMatch |
Object | No |
Match for the customer's city or region, or both, is found. |
confidence.noDob.inexactMatch.addressMatch.noCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.noDob.inexactMatch.addressMatch.mismatchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.noDob.inexactMatch.addressMatch.matchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.noDob.inexactMatch.addressMismatch |
Object | No |
Match for the customer's city or region, or both, is not found. |
confidence.noDob.inexactMatch.addressMismatch.noCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.noDob.inexactMatch.addressMismatch.mismatchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.noDob.inexactMatch.addressMismatch.matchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.noDob.exactMatch |
Object | No |
Exact match of the customer's name is found, but a date of birth is not. |
confidence.noDob.exactMatch.noAddress |
Object | No |
No city and no region is available to match against. |
confidence.noDob.exactMatch.noAddress.noCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.noDob.exactMatch.noAddress.mismatchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.noDob.exactMatch.noAddress.matchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.noDob.exactMatch.addressMatch |
Object | No |
Match for the customer's city or region, or both, is found. |
confidence.noDob.exactMatch.addressMatch.noCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.noDob.exactMatch.addressMatch.mismatchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.noDob.exactMatch.addressMatch.matchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.noDob.exactMatch.addressMismatch |
Object | No |
Match for the customer's city or region, or both, is not found. |
confidence.noDob.exactMatch.addressMismatch.noCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.noDob.exactMatch.addressMismatch.mismatchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.noDob.exactMatch.addressMismatch.matchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.dob |
Object | No |
Confidence level settings for AML matches based on date of birth. |
confidence.dob.inexactMatch |
Object | No |
Exact match of the customer's date of birth and a fuzzy, or inexact, name match is found. |
confidence.dob.inexactMatch.noAddress |
Object | No |
No city and no region is available to match against. |
confidence.dob.inexactMatch.noAddress.noCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.dob.inexactMatch.noAddress.mismatchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.dob.inexactMatch.noAddress.matchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.dob.inexactMatch.addressMatch |
Object | No |
Match for the customer's city or region, or both, is found. |
confidence.dob.inexactMatch.addressMatch.noCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.dob.inexactMatch.addressMatch.mismatchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.dob.inexactMatch.addressMatch.matchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.dob.inexactMatch.addressMismatch |
Object | No |
Match for the customer's city or region, or both, is not found. |
confidence.dob.inexactMatch.addressMismatch.noCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.dob.inexactMatch.addressMismatch.mismatchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.dob.inexactMatch.addressMismatch.matchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.dob.exactMatch |
Object | No |
Exact match of the customer's date of birth and name is found. |
confidence.dob.exactMatch.noAddress |
Object | No |
No city and no region is available to match against. |
confidence.dob.exactMatch.noAddress.noCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.dob.exactMatch.noAddress.mismatchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.dob.exactMatch.noAddress.matchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.dob.exactMatch.addressMatch |
Object | No |
Match for the customer's city or region, or both, is found. |
confidence.dob.exactMatch.addressMatch.noCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.dob.exactMatch.addressMatch.mismatchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.dob.exactMatch.addressMatch.matchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.dob.exactMatch.addressMismatch |
Object | No |
Match for the customer's city or region, or both, is not found. |
confidence.dob.exactMatch.addressMismatch.noCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.dob.exactMatch.addressMismatch.mismatchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.dob.exactMatch.addressMismatch.matchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.inexactYob |
Object | No |
Confidence level settings for AML matches based on a near match of year of birth. |
confidence.inexactYob.inexactMatch |
Object | No |
Near match of the customer's year of birth and a fuzzy, or inexact, name match is found. |
confidence.inexactYob.inexactMatch.noAddress |
Object | No |
No city and no region is available to match against. |
confidence.inexactYob.inexactMatch.noAddress.noCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.inexactYob.inexactMatch.noAddress.mismatchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.inexactYob.inexactMatch.noAddress.matchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.inexactYob.inexactMatch.addressMatch |
Object | No |
Match for the customer's city or region, or both, is found. |
confidence.inexactYob.inexactMatch.addressMatch.noCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.inexactYob.inexactMatch.addressMatch.mismatchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.inexactYob.inexactMatch.addressMatch.matchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.inexactYob.inexactMatch.addressMismatch |
Object | No |
Match for the customer's city or region, or both, is not found. |
confidence.inexactYob.inexactMatch.addressMismatch.noCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.inexactYob.inexactMatch.addressMismatch.mismatchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.inexactYob.inexactMatch.addressMismatch.matchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.inexactYob.exactMatch |
Object | No |
Near match of the customer's year of birth and an exact name match is found. |
confidence.inexactYob.exactMatch.noAddress |
Object | No |
No city and no region is available to match against. |
confidence.inexactYob.exactMatch.noAddress.noCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.inexactYob.exactMatch.noAddress.mismatchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.inexactYob.exactMatch.noAddress.matchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.inexactYob.exactMatch.addressMatch |
Object | No |
Match for the customer's city or region, or both, is found. |
confidence.inexactYob.exactMatch.addressMatch.noCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.inexactYob.exactMatch.addressMatch.mismatchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.inexactYob.exactMatch.addressMatch.matchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.inexactYob.exactMatch.addressMismatch |
Object | No |
Match for the customer's city or region, or both, is not found. |
confidence.inexactYob.exactMatch.addressMismatch.noCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.inexactYob.exactMatch.addressMismatch.mismatchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
confidence.inexactYob.exactMatch.addressMismatch.matchingCountry |
String | No |
Degree of confidence to assign. Valid values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.