ID Analyzer Developer ID Analyzer Developer
  • Home
  • Portal
  • Support
ID Analyzer Developer ID Analyzer Developer
ID Analyzer Developer
  • Home
  • Portal
  • Support
  • Home
  • Core API
    • Overview
    • Quick Start
    • API Reference
  • DocuPass API
    • Overview
    • Quick Start
    • API Reference
  • Vault API
    • Overview
    • Quick Start
    • API Reference
  • AML API
    • Overview
    • Quick Start
    • API Reference
  • Client Library
    • PHP
    • .NET
    • NodeJS
    • Python
  • Guide
    • Web-based ID Scanner
    • DocuPass Custom UI Design
  • Change Log
  • ID Fort On-Premise

AML API Reference

Getting Started

ID Analyzer AML API is accessed through the HTTP protocol by making a POST request with the document image and optional parameters to the API endpoint:

                    https://api.idanalyzer.com/aml
                

AML API supports two types of POST requests: x-www-form-urlencoded and application/json, simply choose the one you find most convenient and be sure to set the correct Content-Type header in your request.

Searching AML Database

AML API allows you to search ID Analyzer global AML database for sanctions, PEPs and wanted criminals using either a name, document number or both. You may further filter the results with birthday and nationality.

Parameters
Key Value Description
name String Requires 1 Person or organization's name or alias in any language.
documentnumber String Requires 1 Person's passport number, national ID number or driving license number etc.
entity person: Person
legalentity: Company or Organization
Optional Return only entities with specified entity type, leave blank to return both person and legal entity.
country String Optional Return only entities with matching country/nationality or no country information.
dob String Optional Return only entities with matching birthday or no birthday information.
database String Optional Specify the source databases to perform AML check, if left blank, all source databases will be checked. Separate each database code with comma, for example: un_sc,us_ofac. For full list of source databases and corresponding code visit AML API Overview.

API Response

Response (No Match)
{
    "items": []
}
Response (Match)
{
    "items": [
        {
            "entity": "person",
            "fullname": [
                "Zulkepli Bin Marzuki"
            ],
            "firstname": [
                "Zulkepli"
            ],
            "lastname": [
                "Marzuki"
            ],
            "alias": [
                 "Zulk Marzuki"
            ],
            "dob": [
                "1968-07-03"
            ],
            "address": [
                "Taman Puchong Perdana"
            ],
            "nationality": [
                "MY"
            ],
            "gender": [
                "M"
            ],
            "documentnumber": [
                {
                    "id": "680703-10-5821",
                    "id_formatted": "680703105821",
                    "country": "my",
                    "type": "I"
                },
                {
                    "id": "A 5983063",
                    "id_formatted": "A5983063",
                    "country": "my",
                    "type": "P"
                }
            ],
            "program": [
                "Ordinance of 2 October 2000 on measures against individuals and entities associated with Usama bin Laden, the group \u00abAl-Qa\u00efda\u00bb or the Taliban (SR 946.203), annex 2"
            ],
            "note": [
                "Review pursuant to Security Council resolution 1822 (2008) was concluded on 19 Jun 2009."
            ],
            "status": [
                "Listed on: 19 Jun 2009 (Relisted on 3 Aug. 2020)"
            ],
            "time": "2013-04-17T22:00:00.000Z",
            "source": [
                "https:\/\/www.seco.admin.ch\/seco\/en\/home\/Aussenwirtschaftspolitik_Wirtschaftliche_Zusammenarbeit\/Wirtschaftsbeziehungen\/exportkontrollen-und-sanktionen\/sanktionen-embargos.html"
            ],
            "database": "ch_seco",
            "schema": "sanction"
        }
    ]
}
Response Reference
The AML database may not contain all the information fields listed below, in such case, the field will be omitted from the response.
Key Type Description
entity String person or legalentity
fullname Array Person or legal entity name(s)
firstname Array Person first name(s)
middlename Array Person middle name(s)
lastname Array Person last name(s)
alias Array Alternative or foreign name(s) of the entity
dob Array Peron's birthday, could come in YYYY, YYYY-MM, or YYYY-MM-DD formats.
address Array Address or residing country of the entity
nationality Array Country or nationality of the entity
birthplace Array Peron's birth place
gender Array Peron's gender: M or F
birthplace Array Peron's birth place
documentnumber Array A list of documents associated with the entity, each item may contain the following keys:
id: Document number
id_formatted: Alphanumeric document number
country: ISO2 country code
type: P = Passport number, I = ID number, D = Driving license number, O = Other/Unknown document type
summary: Additional information
program Array Sanction program(s)
note Array Additional note for the entity
status Array Position/title of the entity or current status of the sanction
time String UTC TZ timestamp when entity was added to the source list or last updated
source Array A list of official source URL(s)
database String ID Analyzer AML database code
On this page:
Getting Started Search AML Datbase

© 2025 All Rights Reserved by ID Analyzer