DKBSignDocs

API reference

POSTRequires Bearer token

Record an audit event

/api/logs-audit/events

Company-admin. category and event_code are required. outcome defaults to success, severity to low, source_service to front.

Path parameters

This endpoint has no path parameters.

Query parameters

This endpoint has no query parameters.

Request body

FieldTypeDescription
category
Required
stringEvent category.
e.g. "security"
event_code
Required
stringStable code (1–120 characters).
e.g. "document.downloaded"
action
stringOptional activity action.
e.g. "download"
occurred_at
stringISO datetime (default now).
actor
stringActor display name.
e.g. "Jane Doe"
actor_email
stringActor email.
e.g. "jane@acme.test"
actor_user_id
stringActor user id.
target
stringTarget label.
e.g. "Contract.pdf"
detail
stringHuman-readable description.
ip
stringClient IP.
outcome
stringsuccess or failure (default success).
e.g. "success"
severity
stringSeverity (default low).
e.g. "low"
source_service
stringOrigin (default front).
e.g. "front"
metadata
objectOptional extra context.

Responses

StatusMeaning
201Recorded
401Missing or invalid Bearer token.

Request

curl
curl -X POST 'https://api.dkbsigns.com/api/logs-audit/events' \
  -H 'Authorization: Bearer $DKBSIGN_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"category":"security","event_code":"document.downloaded","action":"download","actor":"Jane Doe","actor_email":"jane@acme.test","target":"Contract.pdf","outcome":"success","severity":"low","source_service":"front"}'

Response 201

json
{
  "id": 91,
  "org_id": "1",
  "occurred_at": "2026-03-01T10:00:00Z",
  "actor": "Jane Doe",
  "actor_email": "user@acme.test",
  "category": "signature",
  "event_code": "document.downloaded",
  "action": "download",
  "target": "Contract.pdf",
  "outcome": "success",
  "severity": "low",
  "source_service": "front",
  "metadata": {}
}