AML API Quick Start Guide
This guide demonstrates the use of ID Analyzer client libraries, if you prefer to proceed without client library or if client library is not available for your language, please continue to
AML API Reference.
Installing Client Library (SDK)
It is recommended to install ID Analyzer client library with package managers.
composer require idanalyzer/id-analyzer-php-sdk
Install-Package IDAnalyzer
Alternatively, you may download the client library and include it in your project manually:
Start Coding
Import ID Analyzer Client Library
To start, import ID Analyzer client library into your project.
// Use composer autoload
require("vendor/autoload.php");
// Or manually load DocuPass class
// require("../src/AMLAPI.php");
use IDAnalyzer\AMLAPI;
const IDAnalyzer = require("idanalyzer");
Initialize AML API
The very first step is to initialize AML API with your API Key, you can also set an API region (US or EU).
$aml = new AMLAPI("Your API Key", "US");
AMLAPI aml = new AMLAPI("Your API Key", "US");
let aml = new IDAnalyzer.AMLAPI("Your API Key","US");
aml = idanalyzer.AMLAPI("Your API Key", "US")
Setting Source Database
We need to first work out if we want to search through the entire AML database sources, or only some of them. You can check out available databases in AML API Overview. If you only want to search for politically exposed persons(PEPs), you can use the following codes.
// Set AML database to only search the PEP category
$aml->setAMLDatabase("global_politicians,eu_cors,eu_meps");
// Set AML database to only search the PEP category
aml.SetAMLDatabase("global_politicians,eu_cors,eu_meps");
// Set AML database to only search the PEP category
aml.setAMLDatabase("global_politicians,eu_cors,eu_meps");
# Set AML database to only search the PEP category
aml.set_aml_database("global_politicians,eu_cors,eu_meps")
Search AML Database Using Name
We can perform search using a person's name or a legal entity name.
// Search for a politician
$result = $aml->searchByName("Joe Biden");
print_r($result);
// Search for a politician
JObject result = await aml.SearchByName("Joe Biden");
Console.WriteLine(result.ToString(Newtonsoft.Json.Formatting.Indented));
// Search for a politician
aml.searchByName("Joe Biden").then(function (response) {
console.log(response);
}).catch(function (err) {
console.log(err.message);
});
# Search for a politician
response1 = aml.search_by_name("Joe Biden")
print(response1)
Search AML Database Using Document Number
You can also search the database with passport, ID or driving license number.
// Search for a sanctioned ID number
$result = $aml->searchByIDNumber("AALH750218HBCLPC02");
print_r($result);
// Search for a sanctioned ID number
JObject result = await aml.SearchByIDNumber("AALH750218HBCLPC02");
Console.WriteLine(result.ToString(Newtonsoft.Json.Formatting.Indented));
// Search for a sanctioned ID number
aml.searchByIDNumber("AALH750218HBCLPC02").then(function (response) {
console.log(response);
}).catch(function (err) {
console.log(err.message);
});
# Search for a sanctioned ID number
response2 = aml.search_by_id_number("AALH750218HBCLPC02")
print(response2)
Full Demo Code
You may view or download full code examples from GitHub.
You may view or download full code examples from GitHub.
You may view or download full code examples from GitHub.
You may view or download full code examples from GitHub.
Client Library Reference
To read the complete list of methods and parameters for ID Analyzer Client library, visit the link below: