​
AML Screening Individual (v2)

​
Request

[POST]
{{baseUrl}}api/v1/aml/v2/screening
HeaderTypeDescription
AppIdstringCreate an app to get your app ID on dashboard here
Authorizationstringpublic secret key

​
Body parameters

ParameterTypeDescriptionRequired
properties.namesstringFull name of the individual, e.g., β€œNava Gates”required
properties.genderstringGender of the individual, e.g., β€œmale”optional
properties.date_of_birthstringDate of birth in YYYY-MM-DD formatoptional
properties.nationalitystringNationality of the individualoptional
screening_options.pep_checkbooleanPerform Politically Exposed Person (PEP) checkoptional
screening_options.sanctionbooleanPerform sanction screeningoptional
screening_options.adverse_media_checkbooleanPerform adverse media checkoptional
screening_options.watchlistsarraySpecific watchlists to use; leave empty to use alloptional
screening_options.match_thresholdnumberMatch threshold score between 0 and 1, e.g., 0.85optional
screening_options.returned_matches_countnumberReturned matches count (defaults to 30 maximum)optional
schemastringScreening type: β€œindividual” or β€œorganization”required
reference_idstringOptional unique identifier for the screening requestoptional

​
Request Body

Request
{
  "properties": {
    "names": "Nava Gates",
    "gender": "male",
    "date_of_birth": "",
    "nationality": ""
  },
  "screening_options": {
    "pep_check": true,
    "sanction": true,
    "adverse_media_check": false,
    "watchlists": [],
    "match_threshold": 0.85,
    "returned_matches_count": 30
  },
  "schema": "individual",
  "reference_id": ""
}

​
Sample response

Response
{
    "entity": {
        "entity_type": "individual",
        "entity_id": "123450987qwergoi",
        "date": "2025-05-14T01:37:53.423Z",
        "total_results": 7,
        "total_articles": 621151,
        "search_query": "John Doe",
        "risk_level": "Unknown",
        "match_status": "Unknown",
        "results": [
            {
                "name": "John Doe",
                "source_type": "PEP",
                "source_id": "123",
                "titles": [
                    "Mr",
                    "Dr",
                    "Prof"
                ],
                "last_names": [
                    "MURADOV"
                ],
                "alias_names": [
                    "Π“Π΅ΠΎΡ€Π³ΠΈΠΉ Π›ΡŒΠ²ΠΎΠ²ΠΈΡ‡ ΠœΡƒΡ€Π°Π΄ΠΎΠ²"
                ],
                "given_names": [
                    "John"
                ],
                "middle_names": [
                    "Doe"
                ],
                "place_of_birth": [
                    "Doe"
                ],
                "date_of_birth": "1970-01-01",
                "pep_type": "Politically Exposed Person",
                "gender": "Male",
                "country": "Russia",
                "positions": [
                    "Minister of Finance"
                ],
                "nationalities": [
                    "Russian"
                ],
                "citizenship": [
                    "Russian"
                ],
                "occupations": [
                    "Politician"
                ],
                "relations": [
                    {
                        "spouse": "John Doe",
                        "children": "John Doe"
                    }
                ],
                "political_affiliation": [
                    "Communist Party of China"
                ],
                "addresses": [
                    "123 Main St, Anytown, USA"
                ],
                "phone_numbers": [
                    "+1234567890"
                ],
                "urls": [
                    "https://example.com/john-doe"
                ],
                "description": [
                    "John Doe is a Russian citizen who is a former Minister of Finance."
                ],
                "sanction_details": [],
                "other_information": [
                    "John Doe is a Russian citizen who is a former Minister of Finance."
                ],
                "related_entities": [
                    {
                        "spouse": [
                            "John Doe's Wife"
                        ],
                        "siblings": [
                            "John Doe's Children"
                        ]
                    }
                ],
                "media_category": "violent_crime",
                "articles": [
                    {
                        "article_url": "https://example.com/john-doe",
                        "headline": "John Doe Involved in Bribery Scandal",
                        "source": "New York Times",
                        "relevance_score": 0.75,
                        "published_date": "2025-04-29T02:10:00Z"
                    }
                ]
            }
        ]
    }
}

​
AML Categories

adverse_media, sanction, warning, PEP

​
Enhanced Match Scoring Logic

The system will prioritize search results as follows:
  • Sanctions over other AML types
  • Exact name match over inexact name match
  • Date of Birth (DOB) match over no DOB match
  • Country match over no country match over country mismatch

​
Sanctions

  • 1.1 - Fuzzy match with country mismatch
  • 1.2 - Fuzzy match
  • 1.3 - Fuzzy match with country match
  • 1.4 - Fuzzy match with YOB match
  • 1.5 - Fuzzy match with YOB and country match
  • 1.6 - Exact match with country mismatch
  • 1.7 - Exact match
  • 1.8 - Exact match with country match
  • 1.9 - Exact match with YOB match
  • 2.0 - Exact match with YOB and country match

​
Warnings, PEPs, AMs

  • 0.1 - Fuzzy match with country mismatch
  • 0.2 - Fuzzy match
  • 0.3 - Fuzzy match with country match
  • 0.4 - Fuzzy match with YOB match
  • 0.5 - Fuzzy match with YOB and country match
  • 0.6 - Exact match with country mismatch
  • 0.7 - Exact match
  • 0.8 - Exact match with country match
  • 0.9 - Exact match with YOB match
  • 1.0 - Exact match with YOB and country match