Skip to main content

​
Endpoint

GET /clients/business/audits/{auditId}

​
Path parameters

​
auditId
string
required
The unique ID of the audit log entry to retrieve.

​
Headers

​
Authorization
string
required
Bearer YOUR_ACCESS_TOKEN
​
SECRET_KEY
string
required
Your API secret key.
​
businessId
string
required
Your business ID.

​
Response

​
status
boolean
true on success.
​
message
string
Human-readable outcome.
​
data.id
string
Unique audit log ID.
​
data.email
string
Email of the user who performed the action.
​
data.user
string
Full name of the user.
​
data.action
string
Description of the action taken.
​
data.type
string
Category of the event.
​
data.date
string
ISO 8601 timestamp of when the action occurred.
​
data.role
string
Role of the user at the time of the action.
​
data.ipAddress
string
IP address from which the action was performed.

​
Code examples

curl -X GET https://sandbox.stellasbank.com/api/v1/clients/business/audits/AUDIT_ID \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "SECRET_KEY: YOUR_SECRET_KEY" \
  -H "businessId: YOUR_BUSINESS_ID"

​
Example response

{
  "status": true,
  "message": "Audit log 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"
  }
}