Request - Single check
- API key
- Services
enabledon your environment (done by iDenfy's staff) - Credits for each service used
Authorization: API key pair
Method: POST
Endpoint: https://ivs.idenfy.com/aml/check
- AML checks can check only one entity at a time
- Checks that are not being done are omitted from response
Calling the API:
Request Parameters
mode| Type: String| Required: true
Defines how the fraud check will be performed. Select one of the following modes:
IDENTIFICATION
Use this mode to perform checks based on a previous identification process. You will need to provide a scanRef in the data field.
DATA
Use this mode to perform checks by providing all necessary client data directly within the data field.
services| Type: List[String]| Required: true
Specifies which services to apply. Provide a list of service keys. Available services:
AML
Anti-Money Laundering check. Checks against Politically Exposed Persons (PEPs), Sanctions lists, and optionally adverse media.
COMPANY
Company verification. Verifies details of a registered company.
LID
Lost/Invalid Document registry check. Currently applicable for Lithuanian documents only If LID is specified in services and mode is DATA, a country field must be included under data.
data| Type: List[Dict]| Required: true
A list that must contain a single dictionary object. This object holds all necessary data fields for the selected mode and services. The values described has to be used according to mode and services.
scanRef| Type: String
The unique scan reference ID obtained from a previous iDenfy identification process. This is used only when mode is IDENTIFICATION.
Required if mode is IDENTIFICATION.
name| Type: String
Client's first name. Used for AML checks when mode is DATA.
Required if mode is DATA and AML service is used for an individual.
surname| Type: String
Client's last name. Used for AML checks when mode is DATA.
Required if mode is DATA and AML service is used for an individual.
companyName| Type: String
Company's registered name. Used for COMPANY verification when mode is DATA.
Required if mode is DATA and COMPANY service is used.
nameCheck| Type: Bool
Enables Politically Exposed Persons (PEPs) & Sanctions name matching for the AML service. If not provided, it defaults to true.
services: AML, COMPANY
negativeNews| Type: Bool
Enables search for adverse media hits (negative news). If not provided, it defaults to false.
services: AML, COMPANY
probability| Type: Int
Used for filtering results
Minimum similarity threshold (as a percentage) for AML name matching. A higher value signifies a stricter match. Effective only if nameCheck is active. Default is 95.
Integer value from 1 to 100
dateOfBirth| Type: String
Used for filtering results
Client's date of birth. Used to refine AML nameCheck results by filtering out individuals with non-matching birth dates. Effective only if nameCheck is active.
Date format: YYYY-MM-DD. Optional; applicable if AML service with nameCheck is used in mode: DATA.
nationality| Type: String
Used for filtering results
Client's nationality. Used to refine AML nameCheck results by filtering out individuals with non-matching nationalities. Effective only if nameCheck is active.
3-letter ISO country code (e.g., USA, GBR, LTU). Optional; applicable if AML service with nameCheck is used in mode: DATA.
country| Type: String
Country code.
- Used with
LIDservice only (withmode: DATA)
2-letter ISO country code - LT
type| Type: String
Specifies what document type should be checked. Is required for LID services.
Document types:
ID_CARDPASSPORTRESIDENCE_PERMITDRIVER_LICENSE
number| Type: String
The document number as recorded in the LID services.
- 8 digit number
- 9 digit number for
RESIDENCE_PERMIT
Before AML checks are performed (for Identity, Business, or AML verification), the system preprocesses data to handle special characters and formatting.
For example, a name like "John Smith" will match variations such as: John-Smith, John - Smith, "John Smith", John & Smith, John @ Smith, etc.
Response structure & Examples
| Check | |
|---|---|
AML | See Response - Person |
COMPANY | See Response - Company. |
LID | See Response - LID. Lithuanian only |
Request example - AML
{
"mode": "DATA",
"services": ["AML"],
"data": [
{
"probability": 100,
"name": "Alexander",
"surname": "Lukashenko",
"nameCheck": true,
"negativeNews": false
}
]
}
Request example - COMPANY
{
"mode": "DATA",
"services": ["COMPANY"],
"data": [
{
"companyName": "MY AVIATION COMPANY LIMITED",
"negativeNews": false,
"nameCheck": true
}
]
}