API - Transaction
The Transaction API serves as the primary interface for sending transactions to the Transaction Monitoring product, where they are analyzed based on defined business rules. A transaction includes information on the sender, the receiver as well as the value of the transaction itself.
The Transaction API can also be used to update a previously sent transaction, to add or correct information. Updating a transaction will overwrite the previous version of the transaction in the Transaction Monitoring product. Each API call provides a detailed response outlining how the transaction matched against active business rules, including whether and why an alert was triggered.
The API supports receiving 500 concurrent transactions per second.
When a transaction is ingested, the system responds back in under 0.5 second, in which the system does the following:
- Analyse the transaction with the active business rules and generate alerts, if needed.
- Send a response back to customer with the rule execution results for the transaction (indicating if any alert was generated).
- Afterwards, the related alerts are displayed on the system' UI for analysis by the Compliance team.
Specifications of Entities in the Transaction payload
- Each entity in transaction must be either clm-known entity, defined using
by_external_id(which is clm entity id), or unknown entity, defined usingexternal_entity_typeand corresponding entity details. The usage of the two types of entity specificaiton methods are considered to be mutually exclusive and each Entity needs to fit one, and only one type. Meaning that defining bothby_external_idandexternal_entity_typeis not allowed.