Class AMLAPI
AML API allows you to monitor politically exposed persons (PEPs), and discover person or organization on under sanctions from worldwide governments. ID Analyzer AML solutions allows you to check for comprehensive customer due diligence and Anti Money Laundering (AML) and Know Your Customer (KYC) program.
Inheritance
Inherited Members
Namespace: IDAnalyzer
Assembly: IDAnalyzer.dll
Syntax
public class AMLAPI
Constructors
| Improve this Doc View SourceAMLAPI(String, String)
Initialize AML API with an API key, and optional region (US, EU)
Declaration
public AMLAPI(string apikey, string region = "US")
Parameters
Type | Name | Description |
---|---|---|
System.String | apikey | You API key |
System.String | region | US/EU |
Methods
| Improve this Doc View SourceCallAPI(Hashtable)
Declaration
public Task<JObject> CallAPI(Hashtable payload)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Hashtable | payload |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<Newtonsoft.Json.Linq.JObject> |
SearchByIDNumber(String, String, String)
Search AML Database using a document number (Passport, ID Card or any identification documents)
Declaration
public Task<JObject> SearchByIDNumber(string documentNumber = "", string country = "", string dob = "")
Parameters
Type | Name | Description |
---|---|---|
System.String | documentNumber | Document ID Number to perform search |
System.String | country | ISO 2 Country Code |
System.String | dob | Date of birth in YYYY-MM-DD or YYYY-MM or YYYY format. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<Newtonsoft.Json.Linq.JObject> | AML match list |
SearchByName(String, String, String)
Search AML Database using a person or company's name or alias
Declaration
public Task<JObject> SearchByName(string name = "", string country = "", string dob = "")
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Name or alias to search AML Database |
System.String | country | ISO 2 Country Code |
System.String | dob | Date of birth in YYYY-MM-DD or YYYY-MM or YYYY format. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<Newtonsoft.Json.Linq.JObject> | AML match list |
SetAMLDatabase(String)
Specify the source databases to perform AML search, if left blank, all source databases will be checked. Separate each database code with comma, for example: un_sc,us_ofac. For full list of source databases and corresponding code visit AML API Overview.
Declaration
public void SetAMLDatabase(string databases = "au_dfat,ca_dfatd,ch_seco,eu_fsf,fr_tresor_gels_avoir,gb_hmt,ua_sfms,un_sc,us_ofac,eu_cor,eu_meps,global_politicians,interpol_red")
Parameters
Type | Name | Description |
---|---|---|
System.String | databases | Database codes separated by comma |
SetEntityType(String)
Return only entities with specified entity type, leave blank to return both person and legal entity.
Declaration
public void SetEntityType(string entityType = "")
Parameters
Type | Name | Description |
---|---|---|
System.String | entityType | 'person' or 'legalentity' |
ThrowAPIException(Boolean)
Raise APIException when API returns an error
Declaration
public void ThrowAPIException(bool throwException = false)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | throwException | Enable or Disable APIException being thrown |