idanalyzer
Version:
ID Analyzer API client library, scan and verify global passport, driver license and identification card.
1,010 lines (268 loc) • 11.8 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: AMLAPI</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: AMLAPI</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>AMLAPI<span class="signature">(apikey, region)</span><span class="type-signature"></span></h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="AMLAPI"><span class="type-signature"></span>new AMLAPI<span class="signature">(apikey, region)</span><span class="type-signature"></span></h4>
<div class="description">
Initialize AML API with an API key, and optional region (US, EU)
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>apikey</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="default">
</td>
<td class="description last">You API key</td>
</tr>
<tr>
<td class="name"><code>region</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="default">
US
</td>
<td class="description last">US/EU</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="idanalyzer.js.html">idanalyzer.js</a>, <a href="idanalyzer.js.html#line1492">line 1492</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<div class="param-desc">
<span class="param-type">Error</span>
</div>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="searchByIDNumber"><span class="type-signature"></span>searchByIDNumber<span class="signature">(documentNumber, country, dob)</span><span class="type-signature"> → {Promise.<object>}</span></h4>
<div class="description">
Search AML Database using a document number (Passport, ID Card or any identification documents)
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>documentNumber</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Document ID Number to perform search</td>
</tr>
<tr>
<td class="name"><code>country</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">ISO 2 Country Code</td>
</tr>
<tr>
<td class="name"><code>dob</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Date of birth in YYYY-MM-DD or YYYY-MM or YYYY format</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="idanalyzer.js.html">idanalyzer.js</a>, <a href="idanalyzer.js.html#line1564">line 1564</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<div class="param-desc">
<span class="param-type">Error</span>
</div>
<h5>Returns:</h5>
<div class="param-desc">
AML match list
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<object></span>
</dd>
</dl>
<h4 class="name" id="searchByName"><span class="type-signature"></span>searchByName<span class="signature">(name, country, dob)</span><span class="type-signature"> → {Promise.<object>}</span></h4>
<div class="description">
Search AML Database using a person or company's name or alias
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Name or alias to search AML Database</td>
</tr>
<tr>
<td class="name"><code>country</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">ISO 2 Country Code</td>
</tr>
<tr>
<td class="name"><code>dob</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Date of birth in YYYY-MM-DD or YYYY-MM or YYYY format</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="idanalyzer.js.html">idanalyzer.js</a>, <a href="idanalyzer.js.html#line1542">line 1542</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<div class="param-desc">
<span class="param-type">Error</span>
</div>
<h5>Returns:</h5>
<div class="param-desc">
AML match list
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<object></span>
</dd>
</dl>
<h4 class="name" id="setAMLDatabase"><span class="type-signature"></span>setAMLDatabase<span class="signature">(databases)</span><span class="type-signature"></span></h4>
<div class="description">
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.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>databases</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="default">
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
</td>
<td class="description last">Database codes separated by comma</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="idanalyzer.js.html">idanalyzer.js</a>, <a href="idanalyzer.js.html#line1513">line 1513</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setEntityType"><span class="type-signature"></span>setEntityType<span class="signature">(entityType)</span><span class="type-signature"></span></h4>
<div class="description">
Return only entities with specified entity type, leave blank to return both person and legal entity.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>entityType</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">'person' or 'legalentity'</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="idanalyzer.js.html">idanalyzer.js</a>, <a href="idanalyzer.js.html#line1523">line 1523</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<div class="param-desc">
<span class="param-type">Error</span>
</div>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AMLAPI.html">AMLAPI</a></li><li><a href="CoreAPI.html">CoreAPI</a></li><li><a href="DocuPass.html">DocuPass</a></li><li><a href="Vault.html">Vault</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Sat Apr 17 2021 04:17:06 GMT+0800 (Taipei Standard Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>