Skip to content

Commit a29fb7f

Browse files
committed
SDK-1671: Remove AML docs
1 parent 7db1125 commit a29fb7f

File tree

1 file changed

+0
-61
lines changed

1 file changed

+0
-61
lines changed

README.md

Lines changed: 0 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,6 @@ Entry point explanation
3131
1) [Handling Users](#handling-users) -
3232
How to manage users
3333

34-
1) [AML Integration](#aml-integration) -
35-
How to integrate with Yoti's AML (Anti Money Laundering) service
36-
3734
1) [Running the examples](#running-the-examples) -
3835
How to retrieve a Yoti profile using the token
3936

@@ -170,63 +167,6 @@ age_verification_attribute = profile.get_attribute("age_over:18")
170167
```
171168
You can retrieve the sources and verifiers in the same way as detailed above.
172169

173-
## AML Integration
174-
175-
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 [[email protected]](mailto:[email protected]) for more information.
176-
177-
Yoti will provide a boolean result on the following checks:
178-
179-
* PEP list - Verify against Politically Exposed Persons list
180-
* Fraud list - Verify against US Social Security Administration Fraud (SSN Fraud) list
181-
* Watch list - Verify against watch lists from the Office of Foreign Assets Control
182-
183-
To use this functionality you must ensure your application is part of an Organisation in the Yoti Hub - please see [here](https://developers.yoti.com/yoti-app-integration/yoti-app-integration#step-1-creating-an-organisation) for further information.
184-
185-
For the AML check you will need to provide the following:
186-
187-
* Data provided by Yoti (please ensure you have selected the Given name(s) and Family name attributes from the Data tab in the Yoti Hub)
188-
* Given name(s)
189-
* Family name
190-
* Data that must be collected from the user:
191-
* Country of residence (must be an ISO 3166 3-letter code)
192-
* Social Security Number (US citizens only)
193-
* Postcode/Zip code (US citizens only)
194-
195-
### Consent
196-
197-
Performing an AML check on a person *requires* their consent.
198-
**You must ensure you have user consent *before* using this service.**
199-
200-
### Code Example
201-
202-
Given a YotiClient initialised with your SDK ID and KeyPair (see [Client Initialisation](#client-initialisation)) performing an AML check is a straightforward case of providing basic profile data.
203-
204-
```python
205-
from yoti_python_sdk import aml
206-
from yoti_python_sdk import Client
207-
208-
client = Client(YOTI_CLIENT_SDK_ID, YOTI_KEY_FILE_PATH)
209-
given_names = "Edward Richard George"
210-
family_name = "Heath"
211-
212-
aml_address = aml.AmlAddress(country="GBR")
213-
aml_profile = aml.AmlProfile(
214-
given_names,
215-
family_name,
216-
aml_address
217-
)
218-
219-
220-
aml_result = client.perform_aml_check(aml_profile)
221-
222-
print("AML Result for {0} {1}:".format(given_names, family_name))
223-
print("On PEP list: " + str(aml_result.on_pep_list))
224-
print("On fraud list: " + str(aml_result.on_fraud_list))
225-
print("On watchlist: " + str(aml_result.on_watch_list))
226-
```
227-
228-
Additionally an [example AML application](/examples/aml/app.py) is provided in the examples folder.
229-
230170
## Running the Examples
231171

232172
From the [Yoti Hub](https://hub.yoti.com):
@@ -254,7 +194,6 @@ To run the Flask or Django container:
254194

255195
* [Profile - Django](examples/yoti_example_django)
256196
* [Profile - Flask](examples/yoti_example_flask)
257-
* [AML](examples/aml)
258197
* [Doc Scan](examples/doc_scan)
259198

260199
## Running the Tests

0 commit comments

Comments
 (0)