Retrieve the AML check history by version number and/or fetch only the changes specific to that version.
Usage
Use this API to get the AML history of the verification result. You can get the version number from AML Monitor Update Webhook property updatedAMLVersionNumber
.
Base URL by Region
The base URL you should use depends on the region where your services are hosted. Below are the available URLs for each region. By default, the EU region URL is used.
- EU (Default): https://api.idwise.com/
- UAE: https://api-uae.idwise.com/
- Qatar: https://api-qat.idwise.com/
Authentication
Please refer to the API Credentials and Authentication page for more detailed information.
Table of content
In this page you'll find a detailed documentation about the following models:
Response Model
Here is a sample top-level response you'll get from this API
{
"check_id": "12d62f80e15c1d50ff23db54",
"reference_number": "abc-123-FE13",
"aml_matches":{AMLModel},
}
Property | Description |
---|---|
check_id |
|
reference_number |
|
|
AML Match Model
Property | Description |
---|---|
name |
|
countries |
|
datesOfBirth |
|
notes |
|
datasets |
|
aliases |
|
addresses |
|
sex |
|
score |
|
details |
The See full example here |
resource_id | Unique Id for individual match. Used for whitelist and match status update. |
aml_record_version | version number of the match |
ongoing_monitor_update_type |
|
Example for Details
{
"details": {
"adverse-media": {
"title": string,
"data": { "Country": [string], "Date of Birth": [string] },
"datasets": [string],
"datasets_classes": [string],
"media_links": { "snippet": [string], "title": string, "url": string }
},
"pep-institution": {
"title": "Pep Institution",
"data": {
"Country": [string],
"Political Position": [string],
"Chamber":[string],
"Institution Type":[string]
},
"datasets": [string],
"datasets_classes": [string]
}
},
"is_whitelisted": boolean,
"match_status": string,
"aml_record_version": integer,
"ongoing_monitor_update_type":string,
"match_id": string
}