Skip to main content
AML Screening (v2) for individual and organization

​
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
schemastringScreening type: β€œindividual” or β€œorganization”required
unique_referencestringOptional unique identifier for the screening requestoptional
properties.namesstringFull name of the individual, e.g., β€œJohn Doe”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

​
Sample Request for Individual

Body
{
  "properties": {
    "names": "John Doe",
    "gender": "male",
    "date_of_birth": "",
    "nationality": "",
Β Β Β Β "id_number": "AD45UIOO123"
  },
  "screening_options": {
Β Β Β Β "pep_check": true,
Β Β Β Β "sanction": true,
    "adverse_media_check": true,
    "watchlists": ["OFAC_SDN", "EU_Terrorist"], //leave empty or specific watchlists
    "match_threshold": 0.85 // 1 is the highest
  },
  "schema": "individual",  //individual or organization
Β Β "unique_reference" : "123450987qwergoi"  //optional
}

​
Sample Request for Business

Body
{
  "properties": {
    "names": "Anon Corp",
    "registration_number": ["12345678"],
    "country_of_incorporation": ["US", "GB"],
  },
  "screening_options": {
    "watchlists": ["OFAC_SDN", "EU_Financial"],
    "pep_check": true,
    "adverse_media_check": true,
    "match_threshold": 0.80
  },
Β Β "schema": "organization",
Β Β "unique_reference" : "123450987qwergoi"  //optional
}

​
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": "Medium",
      "match_status": "Confirmed Match",
      "results": [
        Β Β Β Β {
                    "name": "John Doe",
                    "source_type": "PEP", //PEP, CRIMINAL, SANCTIONS, ADVERSE_MEDIA
                    "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",  //if adverse_media
                    "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"
                        }
                    ]
                  }Β Β 
        ]
      }
}

​
Note

  • Arrays are used for when its possible to have multiple values.
  • Sanctions type is either PEP, SANCTIONS, CRIMINAL or ADVERSE_MEDIA.
  • sanctions details is populated when the type is sanctions.
  • media_category and articles are for when the sanctions type is Adverse Media.
Adverse Media
  • Screened against Adverse Media news sources.
Media Categories
  • Political
  • Regulatory
  • Terrorism
  • Financial_crime
  • Organized_crime
  • Violent_crime
Ongoing Monitoring
  • Checked against sanction, PEP and criminal watchlists.
⌘I