Package com.idanalyzer

Class AML

java.lang.Object
com.idanalyzer.AML
public class AML extends Object
AML / PEP / sanctions screening (POST /aml, /amlv3).

  • Method Details

    • search

      public com.fasterxml.jackson.databind.JsonNode search(String name, String idNumber, int entity, String country, List<String> database, String birthYear)
      Screen against the AML database (v1 endpoint). Provide name and/or idNumber.
      Parameters:
      name - full name to screen; optional if idNumber is provided.
      idNumber - identity/document number to screen; optional if name is provided.
      entity - 0=Person, 1=Corporation/Legal Entity
      country - optional ISO country code to narrow the search; null/empty = unrestricted.
      database - optional list of databases (e.g. ["us_ofac","eu_fsf"]); null = all
      birthYear - optional year of birth to refine matches; null/empty = unrestricted.
      Returns:
      the API response as a JsonNode.
      Throws:
      InvalidArgumentException - if neither name nor idNumber is supplied.
      ApiException - if the API returns an error or a transport error occurs.

    • searchV3

      public com.fasterxml.jackson.databind.JsonNode searchV3(String text, String id, int limit, int page)
      Screen against the AML v3 database (POST /amlv3). Provide text or id.
      Parameters:
      text - free-text query (e.g. a name) to screen; optional if id is provided.
      id - record id to look up; optional if text is provided.
      limit - maximum number of results to return; only sent when greater than 0.
      page - page number for paginated results; only sent when greater than 0.
      Returns:
      the API response as a JsonNode.
      Throws:
      InvalidArgumentException - if neither text nor id is supplied.
      ApiException - if the API returns an error or a transport error occurs.