Glossary
This page provides definitions for key terms used throughout the AML API, focusing on its role in managing financial accounts, transactions, customer data, and Anti-Money Laundering compliance. If you come across any unfamiliar terms while reading our docs, you can refer back to this page for clarification.
Use the search bar at the top of the page to quickly find specific terms!
Quick Navigation​
A • B • C • D • E • F • G • H • I • J • K • L • M • N • O • P • R • S • T • U • V • W
A​
Account​
A financial arrangement that allows a customer to deposit, withdraw, and track funds. In the AML API, accounts are identified by their IBAN and linked to customers, beneficiaries, account types, and account statuses.
Account Status​
The current state of an account, such as active, inactive, or frozen. Managed via unique status codes and linked to account types. The API provides full CRUD and pagination for account statuses.
Account Type​
The category or classification of an account — for example savings, checking, or business. Identified by a unique code and administered through dedicated endpoints.
Address Type​
A classification for addresses associated with customers or entities, such as residential, business, or mailing. Identified by a code and managed via the AddressTypes endpoints.
Adverse Media​
Negative news or reports about an individual or entity from publicly available sources, used in AML screening to assess potential risks. Part of the watchlist screening process.
Alert​
A notification generated when a transaction or customer triggers an AML rule. Alerts have a lifecycle — they can be open, in progress, closed as false positive, or closed as reported to authority. Each alert supports attachments, comments, and a full audit history.
Alert Attachment​
A file (document, screenshot, or report) uploaded and linked to a specific alert to support investigation and record-keeping.
Alert Status​
The current state of an alert in the investigation lifecycle. Typical statuses include Open, InProgress, ClosedAsFalsePositive, and ClosedAsReportedToAuthority.
AML (Anti-Money Laundering)​
A set of laws, regulations, and procedures designed to prevent criminals from disguising illegally obtained funds as legitimate income. This API focuses on AML compliance in financial operations, providing scoring, alerting, screening, and rule-management capabilities.
AML Country​
A country record specifically maintained for AML compliance purposes. AML country data may include risk ratings or regulatory classifications that differ from the general country reference data.
AML Property​
A configurable property within the AML subsystem, used to define behaviour, thresholds, or feature flags that control how AML processing operates.
AML Transaction ID​
A unique identifier (UUID format) assigned to a transaction within the AML system for tracking and compliance purposes.
AML Transaction Type​
A category of financial transactions specifically monitored for AML compliance, such as large cash deposits or international wire transfers, with configurable properties in the API.
AMLD (Anti-Money Laundering Directive)​
European Union directives that set out the legal framework for combating money laundering and terrorist financing. Financial institutions must comply with AMLD requirements.
Authentication​
The process of verifying a user's identity to access the API, using JWT (JSON Web Tokens) via a bearer token scheme.
Available Date​
The date on which funds from a transaction become available for use by the account holder.
B​
Batch Actions​
Operations that process multiple records in a single API call — for example, batch-creating, updating, or deleting object parameters, transaction scores CRM entries, or workflow step templates.
Bearer Scheme​
An authentication method where the JWT token is included in the Authorization header of an HTTP request, prefixed with "Bearer".
Behavioural Analysis​
A set of analytical endpoints that retrieve pattern-based insights about a customer's transaction activity over time, helping to detect anomalous or suspicious behaviour.
Beneficiary​
An individual or entity designated to receive benefits from an account or transaction, such as funds or ownership rights. Beneficiaries can be added to or removed from accounts through the API.
Branch​
A physical or logical location of the financial institution, identified by a branch code. The API provides full CRUD operations for managing branch records.
Branch Code​
A unique identifier for the bank branch where a transaction was conducted, linking transactions to physical or logical locations.
Business Type​
A classification for business entities (e.g., sole proprietorship, corporation, partnership), used in customer profiling and risk assessment.
C​
Carrier​
An intermediary or method involved in facilitating a transaction, possibly a third party or delivery mechanism.
Channel​
The medium or method through which a transaction is conducted — for example online banking, mobile app, ATM, or branch counter. Identified by a channel code.
City​
A municipal entity within a country, managed under the Countries endpoints. Cities are associated with a country code and can be created, updated, or deleted.
Commit (Transaction)​
The act of finalising a transaction, moving it from a pending state to a committed state. The AML API provides a dedicated PUT endpoint to commit or uncommit transactions.
Commission​
A fee charged for processing a transaction, expressed as a monetary amount.
Country​
A nation or geographical region, identified by a country code. Used in contexts such as transaction origins, customer residency, or AML compliance. The API supports managing countries along with their cities and provinces.
Create Info​
Metadata about the creation of a resource, typically including fields like createdBy (the user who created it) and createdAt (timestamp).
Credit Amount​
The monetary amount credited to an account in a transaction. The API provides a dedicated endpoint to retrieve credit-amount transaction summaries per customer.
Currency​
A system of money used in a specific country, identified by a currency code (e.g., USD, EUR). Managed through CRUD endpoints with pagination.
Customer​
An individual or entity that holds an account or conducts transactions with the financial institution. The API offers a comprehensive customer controller with 16 operations covering profiles, accounts, groups, rules, and suspicion history.
Customer Code​
A unique identifier assigned to a customer in the banking system, used across the API to reference that customer.
Customer Legal Type​
A classification that indicates the legal structure of a customer — for example, natural person, legal entity, or joint account holder.
Customer Relation​
An association between two customers, capturing relationships such as spouse, parent, legal representative, or beneficial owner.
Customer Status​
The current state of a customer, such as active, suspended, or terminated, identified by a status code.
Customer Type​
A high-level classification of a customer — for example, individual, corporate, or government entity.
D​
Debit Amount​
The monetary amount debited from an account in a transaction.
Default Customer Rule​
A baseline AML rule applied to all customers by default. The API allows toggling (enabling/disabling) default customer rules per customer.
Document Code​
A reference identifier for a document related to a transaction, such as an invoice or receipt.
E​
Education Level​
The highest level of formal education attained by a customer, recorded for KYC and risk-profiling purposes. Managed via the EducationLevels endpoints.
End-to-End Identification​
A unique reference assigned by the initiating party to unambiguously identify a transaction across all parties involved.
Error Result Model​
A standardised error response returned by the API, containing error codes, messages, and validation details to help diagnose failed requests.
F​
False Positive​
An alert that, upon investigation, turns out not to represent actual suspicious activity. Alerts can be closed with a "ClosedAsFalsePositive" status.
G​
Group​
An organisational unit within the AML system, used to assign workflow steps, rules, and permissions. Groups can contain users and have associated rules.
Group Rule​
A rule assigned at the group level, defining AML monitoring behaviour for all members of that group.
H​
Health Check​
An API endpoint that verifies the operational status of the AML API and its dependencies. Returns 204 when healthy or 503 when degraded.
I​
IBAN (International Bank Account Number)​
A standardised international numbering system used to identify bank accounts across national borders. In the AML API, accounts are uniquely identified by their IBAN.
Identity Type​
A classification for identification documents presented by customers, such as passport, national ID card, or driving licence. Managed via the IdentityTypes endpoints.
Initiation​
The process of starting or setting up a financial transaction, such as a payment or transfer.
J​
JWT (JSON Web Token)​
A compact, URL-safe token format used for securely transmitting claims between parties. The AML API uses JWT Bearer tokens for all authenticated requests.
K​
KYC (Know Your Customer)​
Regulatory requirements that oblige financial institutions to verify the identity, suitability, and risks involved with maintaining a business relationship with a customer. The AML API supports KYC through customer profiling, identity management, and screening.
L​
Lifecycle (Transaction)​
The series of states a transaction passes through — from creation to commit, and optionally reversal. Each state transition is recorded and can be queried.
M​
Monetary Amount​
A numeric value representing a sum of money, typically associated with a currency code. Used in transaction amounts, credit amounts, debit amounts, and commissions.
N​
Notification​
A system-generated message triggered by an event (e.g., rule breach, alert creation). Notifications drive the alert and workflow subsystems.
O​
Object​
A configurable entity within the AML rules engine. Objects represent the business concepts (e.g., transaction, customer, account) that rules evaluate against.
Object Parameter​
A property or attribute of an AML object, used within rule expressions to define conditions and thresholds. Supports CRUD and batch actions.
Onboarding Status​
The current stage of a customer's onboarding process — for example, pending review, approved, or rejected. Managed via dedicated CRUD endpoints.
Operator​
A logical or mathematical operator (e.g., equals, greater than, contains) used in rule expressions to compare object parameters against values. Exposed through a read-only paginated endpoint.
Originator​
The party that initiates a financial transaction, captured in transaction records for compliance and traceability.
P​
Page Result​
A paginated response envelope returned by list endpoints, containing the requested page of items along with metadata such as total count, page number, and page size.
Pagination​
The mechanism for retrieving large datasets in manageable chunks. All list endpoints in the AML API accept pageNumber and pageSize parameters.
PEP (Politically Exposed Person)​
An individual who holds or has held a prominent public function, considered higher-risk for AML purposes. PEP screening is part of the watchlist screening process.
Periodic Transaction Summary​
An aggregated view of a customer's transaction activity over defined time periods, retrieved through the behavioural analysis endpoints.
Problem Details​
A standardised error response format (RFC 7807) used by the API to communicate error conditions, including type, title, status, detail, and instance fields.
Product​
A financial product offered by the institution (e.g., mortgage, personal loan, savings plan), identified by a product code.
Profession​
The occupation or professional activity of a customer, recorded for KYC and risk-profiling purposes. Managed via the Professions endpoints.
Province​
An administrative subdivision of a country (e.g., state, region, prefecture), managed under the Countries endpoints alongside cities.
R​
Remittance Information​
Details provided with a payment to explain the reason for the transaction.
Reported to Authority​
An alert resolution status indicating that the suspicious activity has been formally reported to the relevant regulatory or law-enforcement authority.
Reversal (Transaction)​
The act of reversing a previously committed transaction, effectively undoing its financial effect. The API provides a dedicated PUT endpoint for transaction reversal.
Risk Score​
A numeric value assigned to a transaction or customer that quantifies the level of AML risk. Scores are calculated by the scoring engine based on configured rules and thresholds.
Rule​
A configurable compliance condition within the AML system. Rules define what constitutes suspicious activity — for example, a single cash transaction above a certain threshold or multiple transfers to high-risk countries within a time window.
Rule Exception​
A customer-level override that exempts a specific customer from one or more AML rules, typically granted after due diligence. The API supports creating, querying, and deleting rule exceptions.
S​
Sanctions List​
An official list maintained by a government or international body (e.g., UN, EU, OFAC) identifying individuals, entities, or countries subject to trade or financial restrictions.
Scoring Engine​
The subsystem that evaluates every transaction against the configured set of rules and assigns a risk score. Scores, results, and rule-level breakdowns are accessible through the API.
Security Rule Set​
A collection of rules grouped together for evaluation, defining the compliance checks applied to transactions and customers.
Slim Customer​
A lightweight customer representation returned by the API for performance-sensitive list views, containing essential fields without full nested objects.
Step​
A discrete task or action within an alert investigation workflow. Steps can be assigned to users or groups, completed, reverted, and tracked through their history.
Suspicion Status History​
A chronological record of changes to a customer's suspicion status, showing when and why the customer was flagged, cleared, or escalated.
Suspicious Transaction​
A transaction that has been flagged by the scoring engine or manual review as potentially linked to money laundering or other financial crime.
T​
Tax Office​
A government tax authority office, identified by a code. Managed via the TaxOfficesController endpoints for customer and compliance reference data.
Token​
A string representing an access grant, used to authenticate and authorise API requests — typically a JWT issued via the institution's identity provider.
Transaction​
A financial operation involving the movement of money between accounts. In the AML API, transactions have a full lifecycle (create, commit, reverse) and are subject to scoring and monitoring.
Transaction Amount​
The sum of money involved in a particular financial transaction.
Transaction Code​
A unique identifier assigned to a specific financial transaction within the system.
Transaction Overview​
A consolidated view of a transaction's details including scores, rule evaluations, and status, returned by the overview endpoints.
Transaction Score​
A risk score assigned to a specific transaction by the scoring engine, including the rules that contributed to the score and their individual weights.
Transaction Score CRM​
A transaction score record maintained in the CRM subsystem, linking scoring data to customer relationship management. Supports CRUD and batch actions.
Transaction Type​
A classification for financial transactions — for example, deposit, withdrawal, transfer, or payment. Managed via dedicated CRUD endpoints.
Transaction Types Configuration​
A set of configurable parameters that control how transaction types are processed, scored, and monitored within the AML system.
U​
User​
An individual interacting with the API, typically a bank employee, compliance officer, or system administrator with specific permissions.
Username​
The identifier of the user who initiated an action, often a bank employee or the customer in self-service channels.
V​
Validation Error​
An error returned by the API when a request fails input validation, containing details about which fields are invalid and why.
Value Date​
The date on which a transaction affects the account balance for interest calculation or other purposes.
W​
Watchlist Screening​
The process of checking customers against sanctions lists, PEP databases, and adverse-media feeds to identify individuals or entities that pose compliance risks.
Workflow Step Template​
A reusable template that defines the structure and sequence of steps in an alert investigation workflow. Templates can be created, updated, and batch-deleted through the API.
Workflow Template​
A high-level definition of an investigation workflow, specifying which step templates to use and in what order. Workflows can be triggered by transactions or watchlist-screening events.
Workflow Trigger​
The event that initiates a workflow — either a transaction (type 0) or a watchlist screening result (type 1).