new AMLAPI(apikey, region)
Initialize AML API with an API key, and optional region (US, EU)
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
apikey |
string | You API key | |
region |
string | US | US/EU |
- Source:
Throws:
Error
Methods
searchByIDNumber(documentNumber, country, dob) → {Promise.<object>}
Search AML Database using a document number (Passport, ID Card or any identification documents)
Parameters:
| Name | Type | Description |
|---|---|---|
documentNumber |
string | Document ID Number to perform search |
country |
string | ISO 2 Country Code |
dob |
string | Date of birth in YYYY-MM-DD or YYYY-MM or YYYY format |
- Source:
Throws:
Error
Returns:
AML match list
- Type
- Promise.<object>
searchByName(name, country, dob) → {Promise.<object>}
Search AML Database using a person or company's name or alias
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | Name or alias to search AML Database |
country |
string | ISO 2 Country Code |
dob |
string | Date of birth in YYYY-MM-DD or YYYY-MM or YYYY format |
- Source:
Throws:
Error
Returns:
AML match list
- Type
- Promise.<object>
setAMLDatabase(databases)
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.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
databases |
string | 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 | Database codes separated by comma |
- Source:
setEntityType(entityType)
Return only entities with specified entity type, leave blank to return both person and legal entity.
Parameters:
| Name | Type | Description |
|---|---|---|
entityType |
string | 'person' or 'legalentity' |
- Source:
Throws:
Error