The SecurityEvent object

Represents a security-related event in the audit log. Security events track authentication attempts, configuration changes, and suspicious activities for compliance and investigation purposes.

Fields

Field	Type	Description
id REQUIRED	string	Unique identifier for the event
merchantId REQUIRED	string	ID of the merchant this event relates to
type REQUIRED	SecurityEventType	Type of security event SecurityEventType
severity REQUIRED	'info'| 'warning'| 'critical'	Severity level of the event
description REQUIRED	string	Human-readable description of the event
ipAddress OPTIONAL	string	IP address associated with the event
userAgent OPTIONAL	string	User agent string from the request
userId OPTIONAL	string	ID of the user who triggered the event
metadata OPTIONAL	Record<string, unknown>	Additional event-specific data
createdAt REQUIRED	string	ISO 8601 timestamp when the event occurred

Example

{
  "id": "obj_1a2b3c",
  "merchantId": "merchant_1a2b3c",
  "type": "login_success",
  "severity": "info",
  "description": "string",
  "ipAddress": "string",
  "userAgent": "string",
  "userId": "user_1a2b3c",
  "createdAt": "2026-01-15T09:30:00Z"
}