AMLAPI
Table of Contents
- $AMLDatabases : mixed
- $AMLEntityType : mixed
- $apiendpoint : mixed
- $apikey : mixed
- $throwError : mixed
- __construct() : void
- Initialize AML API with an API key, and optional region (US, EU)
- searchByIDNumber() : array<string|int, mixed>
- Search AML Database using a document number (Passport, ID Card or any identification documents)
- searchByName() : array<string|int, mixed>
- Search AML Database using a person or company's name or alias
- setAMLDatabase() : void
- 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.
- setEntityType() : void
- Return only entities with specified entity type, leave blank to return both person and legal entity.
- throwAPIException() : void
- Whether an exception should be thrown if API response contains an error message
- callAPI() : array<string|int, mixed>
Properties
$AMLDatabases
private
mixed
$AMLDatabases
= ""
$AMLEntityType
private
mixed
$AMLEntityType
= ""
$apiendpoint
private
mixed
$apiendpoint
= ""
$apikey
private
mixed
$apikey
$throwError
private
mixed
$throwError
= false
Methods
__construct()
Initialize AML API with an API key, and optional region (US, EU)
public
__construct(string $apikey[, string $region = "US" ]) : void
Parameters
- $apikey : string
-
You API key
- $region : string = "US"
-
US/EU
Tags
Return values
void —searchByIDNumber()
Search AML Database using a document number (Passport, ID Card or any identification documents)
public
searchByIDNumber([string $documentNumber = "" ][, string $country = "" ][, string $dob = "" ]) : array<string|int, mixed>
Parameters
- $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
Tags
Return values
array<string|int, mixed> —AML match list
searchByName()
Search AML Database using a person or company's name or alias
public
searchByName([string $name = "" ][, string $country = "" ][, string $dob = "" ]) : array<string|int, mixed>
Parameters
- $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
Tags
Return values
array<string|int, mixed> —AML match list
setAMLDatabase()
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.
public
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" ]) : void
Parameters
- $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
Return values
void —setEntityType()
Return only entities with specified entity type, leave blank to return both person and legal entity.
public
setEntityType([string $entityType = "" ]) : void
Parameters
- $entityType : string = ""
-
'person' or 'legalentity'
Tags
Return values
void —throwAPIException()
Whether an exception should be thrown if API response contains an error message
public
throwAPIException([bool $throwException = false ]) : void
Parameters
- $throwException : bool = false
-
Enable or Disable APIException being thrown
Return values
void —callAPI()
private
callAPI([array<string|int, mixed> $payload = array() ]) : array<string|int, mixed>
Parameters
- $payload : array<string|int, mixed> = array()