The AML API is based on REST API, which provides access to various functions, including retrieving transaction and address information. This API facilitates interaction between business companies and MatchSystems AML technologies.
The Transaction Dashboard is a separate interface within the AML system that allows for processing information about transactions obtained through the API.
Full documentation for the API, including descriptions of all methods, can be found at https://app.matchsystems.com/api/docs/?urls.primaryName=v4.
An API (Application Programming Interface) is a set of definitions and protocols for developing and integrating software applications, enabling different applications and systems to effectively interact with each other. A REST API is an architectural style for creating web services, allowing various applications and systems to interact over the internet. It uses standard HTTP methods (such as GET, POST), supports various data formats (such as JSON, XML), and provides scalability and ease of maintenance due to its stateless nature. This makes REST API a popular choice for web technology developers.
APIs operate on a request-response model: they accept a request, process it (retrieve data or perform operations), and then send back a response containing the necessary information or execution status. This process facilitates interaction between various systems and applications.
Reading data in an API is done through GET requests, which are used to retrieve information from the server without changing its state. These requests are ideally suited for extracting data, such as lists of items or specific records.
The AML API is a web service based on REST architecture, which includes standardized resource access points, such as /alerts, /transfers/sent, and others. It accepts requests with form-encoded data, uses commonly accepted HTTP status codes, such as 200, 404, 503, etc., and sends responses in JSON format.
Currently, the AML API processes information using a query parameter: an address or a transaction. It provides detailed information including blockchain information and data on risks and categories.
Access to data through the AML API significantly simplifies the process of obtaining quick information about the risks associated with addresses and transactions, improving interaction. Pre-defining risks of addresses or transactions for fraud will positively impact the client company's activities.
To start receiving risk data on addresses and transactions, it is necessary to set up integration with the AML API. After setting up integration, the AML API will provide all the necessary information on risk levels. Detailed information is described in the section API Technical Documentation.
Access to the AML API requires an API key. To create a key, you need to go to User Profile and Create API Key. The created key will then be used in the AML API for connection. The ability to create an API key depends on your access rights in the AML system. Detailed information is described in the section Creating an API Key.