Request - Single check

Requirements

• API key
• Services enabled on your environment (done by iDenfy's staff)
• Credits for each service used

---

aml single check

Authorization: API key pair
Method: POST
Endpoint: https://ivs.idenfy.com/fraud/check

limitations

• 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

Explanation:

Defines how the fraud check will be performed. Select one of the following modes:

IDENTIFICATION

Explanation:

Use this mode to perform checks based on a previous identification process. You will need to provide a scanRef in the data field.

DATA

Explanation:

Use this mode to perform checks by providing all necessary client data directly within the data field.

services| Type: List[String]| Required: true

Explanation:

Specifies which services to apply. Provide a list of service keys. Available services:

AML

Explanation:

Anti-Money Laundering check. Checks against Politically Exposed Persons (PEPs), Sanctions lists, and optionally adverse media.

COMPANY

Explanation:

Company verification. Verifies details of a registered company.

LID

Explanation:

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

Explanation:

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

Explanation:

The unique scan reference ID obtained from a previous iDenfy identification process. This is used only when mode is IDENTIFICATION.

Constraints:

Required if mode is IDENTIFICATION.

name| Type: String

Explanation:

Client's first name. Used for AML checks when mode is DATA.

Constraints:

Required if mode is DATA and AML service is used for an individual.

surname| Type: String

Explanation:

Client's last name. Used for AML checks when mode is DATA.

Constraints:

Required if mode is DATA and AML service is used for an individual.

companyName| Type: String

Explanation:

Company's registered name. Used for COMPANY verification when mode is DATA.

Constraints:

Required if mode is DATA and COMPANY service is used.

nameCheck| Type: Bool

Explanation:

Enables Politically Exposed Persons (PEPs) & Sanctions name matching for the AML service. If not provided, it defaults to true.

Constraints:

services: AML, COMPANY

negativeNews| Type: Bool

Explanation:

Enables search for adverse media hits (negative news). If not provided, it defaults to false.

Constraints:

services: AML, COMPANY

probability| Type: Int

Explanation:

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.

Constraints:

Integer value from 1 to 100

Default value:95

dateOfBirth| Type: String

Explanation:

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.

Constraints:

Date format: YYYY-MM-DD. Optional; applicable if AML service with nameCheck is used in mode: DATA.

nationality| Type: String

Explanation:

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.

Constraints:

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

Explanation:

Country code.

• Used with LID service only (with mode: DATA)

Constraints:

2-letter ISO country code - LT

type| Type: String

Explanation:

Specifies what document type should be checked. Is required for LID services.

Constraints:

Document types:

• ID_CARD
• PASSPORT
• RESIDENCE_PERMIT
• DRIVER_LICENSE

number| Type: String

Explanation:

The document number as recorded in the LID services.

Constraints:

• 8 digit number
• 9 digit number for RESIDENCE_PERMIT

Data Preprocessing

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
    }
  ]
}