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.

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
- AML Field Model
  - AML Applicability Enum
  - AML Match Model

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	Type: `string`, `not_nullable` The unique identifier of the check. This identifier is used across IDWise systems to refer to the check and is auto-generated.
reference_number	Type: `string`, `nullable` This is a custom identifier you could attach to the journey when you start it and it will be available as part of the result graph. This is useful for example to link an identifier of the user in your system to the journey or journeys made by this user thus making it easier locate the user in your system after they finish the journey (this used to be called user_id).
aml_matches	Type: `array [object]`, `nullable` Presents the list of matched records in the datasets for the applicant, each record of matches has the following sub-elements Check the AML Match Model for detailed information .

AML Match Model

Property	Description
name	Type: `string`, `not nullable` The name of the individual found in the associated database entry.
countries	Type: `string`, `nullable` The list of countries from the addresses and nationalities of this individual. It has the format of 2-letter ISO country code.
datesOfBirth	Type: `string`, `nullable` Date in either `YYYY-MM-DD` or `YYYY-MM` or `YYYY` ISO format.
notes	Type: `string`, `nullable` Notes.
datasets	Type: `array[string]`, `nullable` The name of databases in which this match was found. This could be one of the following values: - `Politically Exposed Person` -`Sanctions` -`Adverse Media` -`Regulatory Enforcement List` -`People of Interest` -`Disqualified Director` -`Insolvency` -`Fitness Probity`
aliases	Type: `array[object]`, `nullable` Other names of the individual
addresses	Type: `array[object]`, `nullable` The list of addresses.
sex	Type: `string`, `nullable` The gender of the individual.
score	Type: `float`, `not nullable` The search results are ranked based on a score included in the metadata. This score does not represent an absolute ranking of the matches but rather serves to order the search results and provide a relative indication of their relevance.
details	Type: `object`, `nullable` The `details` field contains dynamic properties such as `title`, `data`, `datasets`, `datasets_classes`, and `media_links`. The type of these properties could be any of the following: string, object, or array. The `data` property is dynamic and can contain any number of key-value pairs. `datasets` and `datasets_classes` are arrays of strings. `media_links` is an object containing properties like `snippet`, `title`, and `url`. See full example here
match_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	Type: `enum`, `nullable` The type of ongoing monitoring update for each match in the AML check if the value is `null` indicating no updates. Possible values are: - `New`: A new match has been added to the AML result. - `Removed`: The match has been removed from the AML result. - `Updated`: The match that existed in a previous version has been updated.

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
}