List audit logs

Endpoint

GET /clients/business/audits

Headers

string

required

Your public API key.

string

required

Your API secret. Use a stl_test_... value in sandbox, stl_live_... in production.

string

required

Your business ID.

Query parameters

integer

Page number. Defaults to 1.

integer

Records per page. Defaults to 10.

string

Filter by the role of the user who performed the action.

string

Filter by the type of action performed, e.g. "login" or "transfer".

string

Filter by audit event type.

string

Filter by the email address of the user who performed the action.

See Pagination for full usage.

Response

boolean

true on success.

string

Human-readable outcome.

array

Array of audit log entries.

string

Unique audit log ID.

string

Email of the user who performed the action.

string

Full name of the user who performed the action.

string

Description of the action taken.

string

Category of the event.

string

ISO 8601 timestamp of when the action occurred.

string

The role of the user at the time of the action.

string

IP address from which the action was performed.

integer

The current page number.

integer

The page size used for this response.

integer

Total number of records matching the current query, across all pages.

integer

The final page number, derived from total ÷ limit. See Pagination — this endpoint uses Shape B.

Code examples

curl -X GET "https://sandbox.stellasbank.com/api/v1/clients/business/audits?page=1&limit=10" \
  -H "x-api-key: stl_c8e286ca55b0123e0b05da047494f585" \
  -H "x-api-secret: stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0" \
  -H "businessId: YOUR_BUSINESS_ID"

const res = await fetch(
  "https://sandbox.stellasbank.com/api/v1/clients/business/audits?page=1&limit=10",
  {
    headers: {
      "x-api-key": "stl_c8e286ca55b0123e0b05da047494f585",
      "x-api-secret": "stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0",
      businessId: "YOUR_BUSINESS_ID",
    },
  }
);
const { data, pagination } = await res.json();

import requests

res = requests.get(
    "https://sandbox.stellasbank.com/api/v1/clients/business/audits",
    headers={
        "x-api-key": "stl_c8e286ca55b0123e0b05da047494f585",
        "x-api-secret": "stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0",
        "businessId": "YOUR_BUSINESS_ID",
    },
    params={"page": 1, "limit": 10},
)
print(res.json())

Example response

{
  "status": true,
  "message": "Audit logs retrieved successfully",
  "data": [
    {
      "id": "audit_001",
      "email": "ada@example.com",
      "user": "Ada Lovelace",
      "action": "Initiated a transfer of ₦1,100",
      "type": "transaction",
      "date": "2024-06-09T14:22:00.000Z",
      "role": "Admin",
      "ipAddress": "102.89.23.44"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 200,
    "totalPages": 20
  }
}

Overview

Members

Business

Virtual accounts

Funds

Bulk transfers

Disputes

Subscriptions

Payouts

Audit logs

Settings

Endpoint

Headers

Query parameters

Response

Code examples

Example response

​Endpoint

​Headers

​Query parameters

​Response

​Code examples

​Example response

Endpoint

Headers

Query parameters

Response

Code examples

Example response