iDenfy · Schema

AmlCheck

AMLAge VerificationBank VerificationBiometricsComplianceFraud PreventionIdentity VerificationKYBKYCMCPOpen BankingRegTechSanctions ScreeningWebhookA2A
View JSON Schema on GitHub

JSON Schema

idenfy-aml-check-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/idenfy/main/json-schema/idenfy-aml-check-schema.json",
  "title": "AmlCheck",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/idenfy-aml-checks-api-openapi.yml#/components/schemas/AmlCheck",
  "oneOf": [
    {
      "$ref": "#/$defs/PersonAmlCheck"
    },
    {
      "$ref": "#/$defs/CompanyAmlCheck"
    }
  ],
  "$defs": {
    "AdverseMediaSearchResult": {
      "type": "object",
      "properties": {
        "title": {
          "type": [
            "string",
            "null"
          ]
        },
        "url": {
          "type": "string",
          "format": "uri"
        },
        "text": {
          "type": [
            "string",
            "null"
          ]
        },
        "score": {
          "type": [
            "integer",
            "null"
          ]
        },
        "type": {
          "allOf": [
            {
              "$ref": "#/$defs/AmlArticleTypeEnum"
            }
          ],
          "nullable": true
        },
        "publishDate": {
          "type": [
            "string",
            "null"
          ],
          "format": "date"
        }
      },
      "required": [
        "publishDate",
        "score",
        "text",
        "title",
        "type",
        "url"
      ]
    },
    "AmlArticleTypeEnum": {
      "enum": [
        "NEGATIVE"
      ],
      "type": "string"
    },
    "AmlCheckMonitoring": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "readOnly": true
        },
        "status": {
          "$ref": "#/$defs/MonitoringStatusEnum"
        },
        "isSubscribed": {
          "type": "boolean"
        },
        "expiration": {
          "type": "string",
          "format": "date-time"
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 32,
            "pattern": "^[^,]+$"
          },
          "default": [],
          "description": "List of case-sensitive strings. Each tag can not be longer than 32 characters.",
          "maxItems": 5
        },
        "created": {
          "type": "string",
          "format": "date-time",
          "readOnly": true
        }
      },
      "required": [
        "created",
        "id"
      ]
    },
    "AmlCheckStatusEnum": {
      "enum": [
        "NOT_CHECKED",
        "NO_FLAGS",
        "FALSE_POSITIVE",
        "TRUE_POSITIVE",
        "FLAGS_FOUND"
      ],
      "type": "string"
    },
    "BusinessSearchDatasetEnum": {
      "enum": [
        "PEP",
        "PEP_LINKED",
        "SAN",
        "SAN_CURRENT",
        "SAN_FORMER",
        "INS",
        "RRE",
        "POI",
        "REL",
        "SOE",
        "SOE_CURRENT",
        "SOE_FORMER"
      ],
      "type": "string"
    },
    "BusinessSearchResult": {
      "type": "object",
      "properties": {
        "version": {
          "type": "integer",
          "description": "The version number can be used by clients to detect when a profile has been changed by our research team."
        },
        "resourceId": {
          "type": "string",
          "description": "The resource ID can be used to retrieve the full profile or the PDF of the business."
        },
        "score": {
          "type": "integer",
          "description": "The match score of the profile."
        },
        "match": {
          "type": "string",
          "description": "The name of the profile that has been matched in the search."
        },
        "name": {
          "type": "string",
          "description": "The primary name of the profile."
        },
        "addresses": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/SearchAddress"
          },
          "description": "The list of profile addresses."
        },
        "datasets": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/BusinessSearchDatasetEnum"
          },
          "description": "The profile datasets\n * PEP - (Deprecated - ignore)\n * PEP_LINKED - Only linked PEPs (PEP by Association)\n * SAN - (Deprecated - ignore)\n * SAN_CURRENT - Only current Sanctions\n * SAN_FORMER - Only former Sanctions\n * INS - Insolvency\n * RRE - Reputational Risk Exposure\n * POI - Profile Of Interest\n * REL - Regulatory Enforcement List\n * SOE - (Deprecated - ignore)\n * SOE_CURRENT - Only current SOE\n * SOE_FORMER - Only former SOE.\n"
        },
        "currentSanBodyIds": {
          "type": "array",
          "items": {
            "type": "integer"
          },
          "description": "The list of IDs of all sanctioning bodies, that are currently sanctioning the given profile. The full list of supported sanction bodies and their IDs is provided by /dictionaries/sanction-bodies endpoint."
        },
        "formerSanBodyIds": {
          "type": "array",
          "items": {
            "type": "integer"
          },
          "description": "The list of IDs of all sanctioning bodies, that were sanctioning the given profile in the past, but do not currently sanction them. The full list of supported sanction bodies and their IDs is provided by /dictionaries/sanction-bodies endpoint."
        }
      },
      "required": [
        "addresses",
        "currentSanBodyIds",
        "datasets",
        "formerSanBodyIds",
        "match",
        "name",
        "resourceId",
        "score"
      ]
    },
    "CompanyAmlCheck": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "readOnly": true
        },
        "clientId": {
          "type": "string",
          "description": "A unique string identifying a client on your side.",
          "maxLength": 100
        },
        "checkedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time",
          "readOnly": true
        },
        "created": {
          "type": "string",
          "format": "date-time",
          "readOnly": true
        },
        "userType": {
          "$ref": "#/$defs/UserMonitoringTypeEnum"
        },
        "input": {
          "$ref": "#/$defs/CompanyAmlCheckInput"
        },
        "filter": {
          "$ref": "#/$defs/CompanyAmlCheckFilter"
        },
        "amlCheck": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/BusinessSearchResult"
          },
          "readOnly": true,
          "description": "AML database search result."
        },
        "adverseMedia": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/AdverseMediaSearchResult"
          },
          "readOnly": true,
          "description": "Adverse media database search result."
        },
        "overallStatus": {
          "allOf": [
            {
              "$ref": "#/$defs/AmlCheckStatusEnum"
            }
          ],
          "readOnly": true
        },
        "monitoring": {
          "allOf": [
            {
              "$ref": "#/$defs/AmlCheckMonitoring"
            }
          ],
          "readOnly": true,
          "nullable": true
        }
      },
      "required": [
        "adverseMedia",
        "amlCheck",
        "checkedAt",
        "clientId",
        "created",
        "filter",
        "id",
        "input",
        "monitoring",
        "overallStatus",
        "userType"
      ]
    },
    "CompanyAmlCheckFilter": {
      "type": "object",
      "properties": {
        "threshold": {
          "type": [
            "integer",
            "null"
          ],
          "maximum": 100,
          "minimum": 75,
          "default": 85
        },
        "datasets": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/CompanyAmlCheckFilterDatasetsEnum"
          },
          "description": "Required. Specifies which screening datasets to include in the check."
        },
        "sanctionBodies": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "integer",
            "maximum": 80,
            "minimum": 1
          },
          "description": "When searching `SAN` dataset, specify the values of sanctioning bodies that should be included when screening `SAN` dataset. The full list of supported sanction bodies and their values are provided by the API info endpoint. If none sanction bodies are provided the system will search sanctions issued by any sanctioning body."
        }
      }
    },
    "CompanyAmlCheckFilterDatasetsEnum": {
      "enum": [
        "PEP_LINKED",
        "SAN_CURRENT",
        "SAN_FORMER",
        "INS",
        "RRE",
        "POI",
        "REL",
        "SOE_CURRENT",
        "SOE_FORMER"
      ],
      "type": "string"
    },
    "CompanyAmlCheckInput": {
      "type": "object",
      "properties": {
        "companyName": {
          "type": "string",
          "maxLength": 200
        },
        "country": {
          "allOf": [
            {
              "$ref": "#/$defs/CountryEnum"
            }
          ],
          "nullable": true
        }
      },
      "required": [
        "companyName"
      ]
    },
    "CountryEnum": {
      "enum": [
        "AF",
        "AX",
        "AL",
        "DZ",
        "AS",
        "AD",
        "AO",
        "AI",
        "AQ",
        "AG",
        "AR",
        "AM",
        "AW",
        "AU",
        "AT",
        "AZ",
        "BS",
        "BH",
        "BD",
        "BB",
        "BY",
        "BE",
        "BZ",
        "BJ",
        "BM",
        "BT",
        "BO",
        "BQ",
        "BA",
        "BW",
        "BV",
        "BR",
        "IO",
        "BN",
        "BG",
        "BF",
        "BI",
        "CV",
        "KH",
        "CM",
        "CA",
        "KY",
        "CF",
        "TD",
        "CL",
        "CN",
        "CX",
        "CC",
        "CO",
        "KM",
        "CG",
        "CK",
        "CR",
        "CI",
        "HR",
        "CU",
        "CW",
        "CY",
        "CZ",
        "CD",
        "DK",
        "DJ",
        "DM",
        "DO",
        "EC",
        "EG",
        "SV",
        "GQ",
        "ER",
        "EE",
        "SZ",
        "ET",
        "FK",
        "FO",
        "FJ",
        "FI",
        "FR",
        "GF",
        "PF",
        "TF",
        "GA",
        "GM",
        "GE",
        "DE",
        "GH",
        "GI",
        "GR",
        "GL",
        "GD",
        "GP",
        "GU",
        "GT",
        "GG",
        "GN",
        "GW",
        "GY",
        "HT",
        "HM",
        "HN",
        "HK",
        "HU",
        "IS",
        "IN",
        "ID",
        "IR",
        "IQ",
        "IE",
        "IM",
        "IL",
        "IT",
        "JM",
        "JP",
        "JE",
        "JO",
        "KZ",
        "KE",
        "KI",
        "XK",
        "KW",
        "KG",
        "LA",
        "LV",
        "LB",
        "LS",
        "LR",
        "LY",
        "LI",
        "LT",
        "LU",
        "MO",
        "MG",
        "MW",
        "MY",
        "MV",
        "ML",
        "MT",
        "MH",
        "MQ",
        "MR",
        "MU",
        "YT",
        "MX",
        "FM",
        "MD",
        "MC",
        "MN",
        "ME",
        "MS",
        "MA",
        "MZ",
        "MM",
        "NA",
        "NR",
        "NP",
        "NL",
        "NC",
        "NZ",
        "NI",
        "NE",
        "NG",
        "NU",
        "NF",
        "KP",
        "MK",
        "MP",
        "NO",
        "OM",
        "PK",
        "PW",
        "PS",
        "PA",
        "PG",
        "PY",
        "PE",
        "PH",
        "PN",
        "PL",
        "PT",
        "PR",
        "QA",
        "RE",
        "RO",
        "RU",
        "RW",
        "BL",
        "SH",
        "KN",
        "LC",
        "MF",
        "PM",
        "VC",
        "WS",
        "SM",
        "ST",
        "SA",
        "SN",
        "RS",
        "SC",
        "SL",
        "SG",
        "SX",
        "SK",
        "SI",
        "SB",
        "SO",
        "ZA",
        "GS",
        "KR",
        "SS",
        "ES",
        "LK",
        "SD",
        "SR",
        "SJ",
        "SE",
        "CH",
        "SY",
        "TW",
        "TJ",
        "TZ",
        "TH",
        "TL",
        "TG",
        "TK",
        "TO",
        "TT",
        "TN",
        "TR",
        "TM",
        "TC",
        "TV",
        "UG",
        "UA",
        "AE",
        "GB",
        "UM",
        "US",
        "UY",
        "UZ",
        "VU",
        "VA",
        "VE",
        "VN",
        "VG",
        "VI",
        "WF",
        "EH",
        "YE",
        "ZM",
        "ZW"
      ],
      "type": "string"
    },
    "DateOfBirthMatchingEnum": {
      "enum": [
        "EXACT",
        "SAME_YEAR",
        "WITHIN_ONE_YEAR",
        "WITHIN_TWO_YEARS",
        "WITHIN_THREE_YEARS",
        "WITHIN_FOUR_YEARS",
        "WITHIN_FIVE_YEARS"
      ],
      "type": "string"
    },
    "IndividualDatasetEnum": {
      "enum": [
        "PEP_CURRENT",
        "PEP_FORMER",
        "PEP_LINKED",
        "SAN_CURRENT",
        "SAN_FORMER",
        "INS",
        "RRE",
        "DD",
        "POI",
        "REL",
        "GRI"
      ],
      "type": "string"
    },
    "IndividualSearchResult": {
      "type": "object",
      "properties": {
        "version": {
          "type": "integer",
          "description": "The version number can be used by clients to detect when a profile has changed."
        },
        "resourceId": {
          "type": "string",
          "description": "The resource ID can be used to retrieve the full profile or the PDF of the Individual."
        },
        "score": {
          "type": "integer",
          "description": "The match score of the profile."
        },
        "match": {
          "type": "string",
          "description": "The name of the profile that has been matched in the search."
        },
        "name": {
          "type": "string",
          "description": "The primary name of the profile."
        },
        "addresses": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/SearchAddress"
          },
          "description": "The list of profile addresses and nationalities."
        },
        "nationalities": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/CountryEnum"
          },
          "description": "List of the individual's nationalities."
        },
        "datesOfBirth": {
          "type": "array",
          "items": {
            "type": "string",
            "description": "Date in either YYYY-MM-DD or YYYY-MM or YYYY ISO format."
          }
        },
        "gender": {
          "allOf": [
            {
              "$ref": "#/$defs/MainSexEnum"
            }
          ],
          "description": "Gender (for individuals), if known."
        },
        "profileImage": {
          "type": "string",
          "description": "The primary profile image."
        },
        "datasets": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/IndividualDatasetEnum"
          },
          "description": "The profile datasets\n * PEP_CURRENT - Only current PEPs\n * PEP_FORMER - Only former PEPs\n * PEP_LINKED - Only linked PEPs (PEP by Association)\n * SAN_CURRENT - Only current Sanctions\n * SAN_FORMER - Only former Sanctions\n * INS - Insolvency\n * RRE - Reputational Risk Exposure\n * DD - Disqualified Director\n * POI - Profile Of Interest\n * REL - Regulatory Enforcement List\n * GRI - Gambling Risk Intelligence.\n"
        },
        "currentSanBodyIds": {
          "type": "array",
          "items": {
            "type": "integer"
          },
          "description": "The list of IDs of all sanctioning bodies, that are currently sanctioning the given profile. The full list of supported sanction bodies and their IDs is provided by /dictionaries/sanction-bodies endpoint."
        },
        "formerSanBodyIds": {
          "type": "array",
          "items": {
            "type": "integer"
          },
          "description": "The list of IDs of all sanctioning bodies, that were sanctioning the given profile in the past, but do not currently sanction them. The full list of supported sanction bodies and their IDs is provided by /dictionaries/sanction-bodies endpoint."
        },
        "pepTier": {
          "allOf": [
            {
              "$ref": "#/$defs/PepTierEnum"
            }
          ],
          "description": "Defines the PEP tier of the individual. Where PEP Tier 1 indicates senior roles, PEP Tier 2 - middle-ranking, and PEP Tier 3 - junior officials."
        }
      },
      "required": [
        "addresses",
        "currentSanBodyIds",
        "datasets",
        "datesOfBirth",
        "formerSanBodyIds",
        "match",
        "name",
        "nationalities",
        "resourceId",
        "score"
      ]
    },
    "MainSexEnum": {
      "enum": [
        "MALE",
        "FEMALE"
      ],
      "type": "string"
    },
    "MonitoringStatusEnum": {
      "enum": [
        "ACTIVE",
        "STOPPED",
        "PENDING",
        "ALERT"
      ],
      "type": "string"
    },
    "PepTierEnum": {
      "enum": [
        "PEP_TIER_1",
        "PEP_TIER_2",
        "PEP_TIER_3"
      ],
      "type": "string"
    },
    "PersonAmlCheck": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "readOnly": true
        },
        "clientId": {
          "type": "string",
          "description": "A unique string identifying a client on your side.",
          "maxLength": 100
        },
        "checkedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time",
          "readOnly": true
        },
        "created": {
          "type": "string",
          "format": "date-time",
          "readOnly": true
        },
        "userType": {
          "$ref": "#/$defs/UserMonitoringTypeEnum"
        },
        "input": {
          "$ref": "#/$defs/PersonAmlCheckInput"
        },
        "filter": {
          "$ref": "#/$defs/PersonAmlCheckFilter"
        },
        "amlCheck": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/IndividualSearchResult"
          },
          "readOnly": true,
          "description": "AML database search result."
        },
        "adverseMedia": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/AdverseMediaSearchResult"
          },
          "readOnly": true,
          "description": "Adverse media database search result."
        },
        "overallStatus": {
          "allOf": [
            {
              "$ref": "#/$defs/AmlCheckStatusEnum"
            }
          ],
          "readOnly": true
        },
        "monitoring": {
          "allOf": [
            {
              "$ref": "#/$defs/AmlCheckMonitoring"
            }
          ],
          "readOnly": true,
          "nullable": true
        }
      },
      "required": [
        "adverseMedia",
        "amlCheck",
        "checkedAt",
        "clientId",
        "created",
        "filter",
        "id",
        "input",
        "monitoring",
        "overallStatus",
        "userType"
      ]
    },
    "PersonAmlCheckFilter": {
      "type": "object",
      "properties": {
        "threshold": {
          "type": [
            "integer",
            "null"
          ],
          "maximum": 100,
          "minimum": 75,
          "default": 85
        },
        "datasets": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/PersonAmlCheckFilterDatasetsEnum"
          },
          "description": "Required. Specifies which screening datasets to include in the check."
        },
        "sanctionBodies": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "integer",
            "maximum": 80,
            "minimum": 1
          },
          "description": "When searching `SAN` dataset, specify the values of sanctioning bodies that should be included when screening `SAN` dataset. The full list of supported sanction bodies and their values are provided by the API info endpoint. If none sanction bodies are provided the system will search sanctions issued by any sanctioning body."
        },
        "dateOfBirthMatching": {
          "allOf": [
            {
              "$ref": "#/$defs/DateOfBirthMatchingEnum"
            }
          ],
          "nullable": true,
          "default": "EXACT"
        },
        "pepTiers": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/PepTierEnum"
          }
        }
      }
    },
    "PersonAmlCheckFilterDatasetsEnum": {
      "enum": [
        "PEP_CURRENT",
        "PEP_FORMER",
        "PEP_LINKED",
        "SAN_CURRENT",
        "SAN_FORMER",
        "INS",
        "RRE",
        "DD",
        "POI",
        "REL"
      ],
      "type": "string"
    },
    "PersonAmlCheckInput": {
      "type": "object",
      "properties": {
        "fullName": {
          "type": "string",
          "maxLength": 200
        },
        "nationality": {
          "allOf": [
            {
              "$ref": "#/$defs/CountryEnum"
            }
          ],
          "nullable": true
        },
        "dateOfBirth": {
          "type": [
            "string",
            "null"
          ],
          "format": "date"
        },
        "sex": {
          "allOf": [
            {
              "$ref": "#/$defs/MainSexEnum"
            }
          ],
          "nullable": true
        }
      },
      "required": [
        "fullName"
      ]
    },
    "SearchAddress": {
      "type": "object",
      "properties": {
        "geography": {
          "type": "string",
          "description": "An upper-case two-letter ISO-3166-2 code of a country or dependent territory of the profile address or profile nationality."
        },
        "city": {
          "type": "string",
          "description": "The city name of the profile address."
        }
      },
      "required": [
        "geography"
      ]
    },
    "UserMonitoringTypeEnum": {
      "enum": [
        "COMPANY",
        "PERSON"
      ],
      "type": "string"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/idenfy-aml-check"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.