> For the complete documentation index, see [llms.txt](https://legacy-docs.usesmileid.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://legacy-docs.usesmileid.com/integration-options/server-to-server/ruby/products/aml-check.md). # AML Check Required Class: **AmlCheck Class** ## Running AML Check on Ruby 1. Get your Smile ID `Partner ID` 2. Get your API Key (take note of the environment you are running the job in) 3. Get the required details from your users 4. Submit the Job to Smile ID 5. Interpret your results ### Get your Partner ID You can find your Partner ID in the menu list when logged into [the portal](https://portal.usesmileid.com/partner/dashboard). ![](/files/5bAEvct4lkb2MvYp3h3I) ### Get your API Key Your api key is in the developer section of [the portal.](https://portal.usesmileid.com/api-key) * Click on the **Generate New API Key** button * Copy your api key (ensure you are in the right environment) ![Generate a new API Key](/files/5de0FSBPKuA9KoRJZ0Gj) ![Copy your API Key](/files/GUr0iFqBeWmWdAmCfph2) ### Get the User's details To submit an AML check job, you need the `full name` of the user, the `birth year` and the user's `known nationalities`. You can optionally include `aliases` (secondary or alternative names) to broaden the screening search. ### Submit the Job to Smile ID You can copy the sample code below and edit with your partner and job details. ```ruby require 'smile-identity-core' # Initialize partner_id = ''; # login to the Smile ID portal to view your partner id api_key = ''; # copy your API key from the Smile ID portal sid_server = '<0 or 1>'; # Use '0' for the sandbox server, use '1' for production server connection = SmileIdentityCore::AmlCheck.new(partner_id, api_key, sid_server) # Create required tracking parameters request_params = { job_id: '', user_id: '', full_name: '', countries: '', aliases: '', birth_year: '', # set search_existing_user to true to re-use the name and birth year from a previous # biometric kyc or document verification job. NOTE: user_id must be the same as # submitted with the biometric kyc or document verification job search_existing_user: '', optional_info: '' }; # Submit the job response = connection.submit_job(request_params) ``` **Example Response Body** Your response will return a JSON String containing the below: ```json { "Actions": { "Listed": "Listed" }, "PartnerParams": { "job_type": 10, "user_id": "4cb0f26-2b567-5800-b05e-c0f095g6036", "job_id": "3ba0e15e-1a56-4799-a94d-b0e084f50256" }, "SmileJobID": "0000000411", "no_of_persons_found": 1, "people": [ { "addresses": ["Burbank"], "adverse_media": [ { "date_published": "2021-09-24", "publisher": "Regulatory Times", "source_link": "https:regulatorytimes.com/article", "title": "Jon Doe angered regulators" } ], "aliases": ["John Doe"], "associations": [ { "association_type": "PEP", "name": "Bob Smith", "relationship": "Bob Smith is an associate of John Leo Doe" } ], "dates_of_birth": ["1984-07-16"], "name": "John Leo Doe", "nationalities": ["American"], "news_summary": [ { "newsCategoryLabel": "Terrorism", "newsCategory": "terrorism", "numberOfArticles": 46 } ], "pep": { "pep_level": 1, "political_positions": [ { "country": "United States", "from": "2020-01-05", "position": "Representative", "to": "2022-01-05" }, { "country": "United States", "from": "2022-01-05", "position": "Senator", "to": null } ], "sources": [ { "source_link": "https://www.senate.gov/senators/", "source_name": "senate.gov" } ] }, "sanctions": [ { "date_of_birth": "", "nationality": "American", "source_details": { "listed_date": "2020-01-05", "source_link": ["https://sanctionslist.com"], "source_name": "Office of Foreign Assets Control (OFAC)", "source_type": "Sanctions" } } ] } ], "ResultCode": "1030", "ResultText": "Found on list", "signature": "...", "timestamp": "2023-02-17T16:24:16.835Z" } ``` ### Interpret your Results You can read more about result codes and responses in the [AML check](https://docs.usesmileid.com/products/for-individuals-kyc/aml-check) section of the docs. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://legacy-docs.usesmileid.com/integration-options/server-to-server/ruby/products/aml-check.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.