Get Aml Result

Usage

Use this API to get the final verification result.

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

Here is a sample top-level response you'll get from this API

{
	"check_id": "12d62f80e15c1d50ff23db54",		
	"reference_number": "abc-123-FE13",	
	"check_time": "2023-01-26T08:13:00.454774",
	"final_decision":"Refer",					
	"aml":{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).

check_time

  • *Type:** datetime
    The date time stamp when this check was finished. The format of this field is also ISO 8601 Date Time string.

final_decision

  • *Type:** string (enum)
    Is the latest decision so far. It will contain the system_decision (Complete or Refer) if there has not been manual review done. Otherwise it will contain the manual_decision (Approved, Rejected).

aml

AML Field Model

Shows the applicant’s records over Anti Money Laundering (AML) databases if exist. Here are the attributes that constitute an aml element:

Property

Description

matches

ongoing_monitoring_enabled

  • *Type:** bool
    Represent if ongoing monitoring is enabled or not.

last_ongoing_monitoring_update

  • *Type:** string
    is the last datetime when monitoring status was changed.

search_datetime

  • *Type:** string
    is the datetime when search was requested.

AML Match Model

Property

Description

name

  • *Type: ** string, not nullable
    The name of the profile found in the associated database entry.

countries

  • *Type: ** array[string], nullable
    The list of countries from the addresses and nationalities of this profile.

datesOfBirth

  • *Type: ** array[string], nullable
    list of dates 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[string], nullable
    Other names of the profile

addresses

  • *Type: ** array[object], nullable
    The list of addresses.

sex

  • *Type: ** string, nullable
    The gender of the person.

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

resource_id

Unique Id for individual match. Used for whitelist and match status update.

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]  
        },
       ....
    }  
}
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!