Swagger hero Background

iAML API Hub

One platform. One API. Full support for AML and Compliance processes.
iAML API Hub is an integration module providing access to AML, KYC, KYB, Compliance Intelligence and risk assessment services through a unified API interface.

iAML API Hub provides access to proprietary PEP and RCA databases, over 75 sanction lists and other lists, as well as data from national and international sources through one consistent API.
Table of contents

1. Available Services

Record Check (PDF)
Verification of a person or entity against a selected list, including PDF report generation.
Sanction Screening
Verification of persons and entities against sanction lists (75+).
PEP Screening
Identification of politically exposed persons (PEP) and their close associates (RCA).
Regulatory & Warning Lists
Verification of persons and entities against warning lists and other risk sources (KNF Warning List, EURO-BOZON, Virtual Currency Register, Gambling Domains Register, ERUP).
Beneficial Ownership Verification
Identification and analysis of ultimate beneficial owners and ownership structures (CRBR).
KYB Verification
Verification of company registration data, legal status, management and ownership structure (GUS BIR, CRBR, KRS, VAT White List, VIES).
Risk Intelligence
(Risk Matrix & Risk Score)
Support for risk assessment processes through automated risk analysis and scoring.
Ongoing Monitoring
Continuous monitoring of changes in sanctions, PEP status and other risk events.

2. Data Sources & Integrations

iAML API Hub integrates data from national public registers, compliance databases, sanction lists and proprietary sources.

3. Authentication

All API calls require authorisation.
Supported methods
API Key – HTTP header
Recommended. The key is passed in the X-Api-Key header.
API Key – query parameter
Alternatively, the key can be passed in the api_key query parameter.

4. Environments

5. Response Format

All responses are returned in JSON format. Data is returned under a key matching the resource (e.g. peps, rcas, sanctions, records), and error responses contain a message field with an optional errors list.
Example success response (200 OK) – GET /v1/risk?name=...:
{
    "risk": {
        "pl": "niskie",
        "lvl": 0
    }
}
Copy
Example error response (412 Precondition Failed):
{
    "message": "Precondition Failed",
    "errors": [
        "Zapytanie nie moze być puste."
    ]
}
Copy

6. HTTP Response Codes

The API returns standard HTTP response codes.
Code
200
Operation completed successfully
202
Request accepted – the resource is being prepared, retry the request (e.g. a PDF report)
400
Invalid input data
401
Missing authorisation (invalid API key)
403
Insufficient permissions or request limit exceeded
404
Resource not found
410
The resource has expired and is no longer available (e.g. a PDF report)
412
Parameter validation failed (message field with an errors list)
500
Server error

7. Security

iAML API Hub has been designed in accordance with security and data protection principles.
Key mechanisms include
TLS communication encryption
Secure API authentication
Access control
Operation logging
Security monitoring
Minimisation of processed data

8. Support

9. Platform Development

As part of further platform development, additional API modules are planned.
Ready
Analytics API
API for managing AML analyses, screening, monitoring and risk assessment of persons, entities and other objects.
In preparation
Data Hub API
API for sharing and downloading reference data, files and iAML data packages in various formats.
In preparation
Case Management API
API for creating, updating and managing cases, alerts and their handling process.
In preparation
Notification API
API for sending and managing system notifications, alerts and user communication.
Planned
Workflow Automation API
API for automating business processes, approvals, tasks and workflows in the iAML platform.
Planned
AI Compliance Services
A set of AI services supporting data analysis, risk assessment, recommendation generation and compliance process automation.