From 33188409d7d2b64ef5f008fd1385da939c0eadbf Mon Sep 17 00:00:00 2001 From: David Grayston Date: Wed, 5 Aug 2020 18:07:55 +0100 Subject: [PATCH] SDK-1671: Remove AML docs --- README.md | 1 - docs/AML.md | 56 ----------------------------------------------------- 2 files changed, 57 deletions(-) delete mode 100644 docs/AML.md diff --git a/README.md b/README.md index 7afbae7e..dc6d2fff 100755 --- a/README.md +++ b/README.md @@ -73,7 +73,6 @@ For each service you will need: The Yoti SDK can be used for the following products, follow the links for more information about each: 1) [Yoti app integration](/docs/PROFILE.md) - Connect with already-verified customers. 1) [Yoti Doc Scan](/docs/DOCSCAN.md) - Identity verification embedded in your website or app. -1) [Yoti AML](/docs/AML.md) - Anti-Money Laundering check service to allow a deeper KYC process, preventing fraud ## Support diff --git a/docs/AML.md b/docs/AML.md deleted file mode 100644 index 7f57e50f..00000000 --- a/docs/AML.md +++ /dev/null @@ -1,56 +0,0 @@ -# AML Integration - -## About - -Yoti provides an AML (Anti Money Laundering) check service to allow a deeper KYC process to prevent fraud. This is a chargeable service, so please contact [sdksupport@yoti.com](mailto:sdksupport@yoti.com) for more information. - -Yoti will provide a boolean result on the following checks: - -* PEP list - Verify against Politically Exposed Persons list -* Fraud list - Verify against US Social Security Administration Fraud (SSN Fraud) list -* Watch list - Verify against watch lists from the Office of Foreign Assets Control - -To use this functionality you must ensure your application is assigned to your Organisation in the Yoti Hub - please see [here](https://developers.yoti.com/yoti-app/web-integration#step-1-creating-an-organisation) for further information. - -For the AML check you will need to provide the following: - -* Data provided by Yoti - * Given name(s) - * Family name - * Postcode/Zip code (US citizens only) - this can be retrieved from the Structured Postal Address attribute - -* Data that must be collected from the user: - * Country of residence (must be an ISO 3166 3-letter code) - * Social Security Number (US citizens only) - -## Consent - -Performing an AML check on a person *requires* their consent. -**You must ensure you have user consent *before* using this service.** - -## Performing a Check - -Given a YotiClient initialised with your SDK ID and KeyPair (see [Client Initialisation](./PROFILE.md#client-initialisation)) performing an AML check is a straightforward case of providing basic profile data. - -```javascript - -// Initiate user profile data. - -const amlAddress = new yoti.AmlAddress('GBR'); -const amlProfile = new yoti.AmlProfile('Edward Richard George', 'Heath', amlAddress); - -yotiClient.performAmlCheck(amlProfile).then((amlResult) => { - console.log(amlResult.isOnPepList); - console.log(amlResult.isOnFraudList); - console.log(amlResult.isOnWatchList); - - // Or - console.log(amlResult); -}).catch((err) => { - console.error(err); -}) -``` - -## Running the example - -- See the [AML Example](../examples/aml-check/README.md) folder for instructions on how to run the AML Example project