The following feature may incur additional costs. If you would like to request early access to this feature, please get in touch with your Mambu Customer Success Manager or contact us through Mambu Support to discuss your requirements. For more information, see Mambu Release Cycle - Feature Release Status .
Welcome
Welcome to the Mambu Audit Trail API Reference documentation!
The Audit Trail capability tracks all activities that were performed in the Mambu Core Banking Engine via either the UI or the V1 and V2 API. Audit records are grouped per tenant. Audit records include who did what and when. You can search and filter through stored events using an API.
A key difference between Audit Trail and Activities is Audit Trail's ability to track both changes to your system, as well as system access history, due to the support for not only write operations such as POST, PUT, DELETE, and PATCH; but also GET (read) operations. This provides more granular user activity tracking, which is not possible in Activities.
Use cases
Some example use cases might be:
- Investigate suspicious activity or potential fraud.
- Detect actions performed by an unauthorized user.
- Monitor and gather data about specific activities or users.
- Track failed login attempts (e.g. brute force attack upon your system).
- Generate compliance and audit reports from audit data.
Use of Audit Trail requires API Consumers, which is an Early Access feature. For more information see Authentication.
The new version of Audit Trail is designed to be more scalable and optimised for storage over speed. Therefore, you may experience slower performance as a result of this design decision.
Audit Trail V2 release information
Audit Trail V2 includes some significant improvements over V1, and some changes which may break your current implementation. Before upgrading to the /v2/events endpoints, please refer to the extensive documentation on this page and the items listed in Backwards Compatibility to ensure that your migration process is smooth.
Supported operations
Base URL: https://TENANT_NAME.mambu.com/api
| Action | Endpoint | Description |
|---|---|---|
GET | /v2/events | Retrieve a list of events. |
GET | /v2/events/metadata | Get information on how much data has been scanned. |
If you are looking for documentation for another API, you can use the Mambu APIs menu to view API Reference documentation for API v1, API v2, Streaming API, or Mambu Payment Gateway. For more information about all the APIs we offer, see Mambu APIs in our User Guide.
Authentication
To authenticate audit trail requests you must use an API key generated by an API consumer that has the Manage Audit Trail (MANAGE_AUDIT_TRAIL) permission assigned to it. For more information, see API Consumers.
Headers
Other than the authentication header with the API key, you do not need to use any additional headers.