Contents

API reference

Audit

API reference descriptions are provided in English to preserve the exact published contract.

List tamper-evident audit entries for the account

GET /v1/accounts/{AC}/audit

Entries are masked by default. `unmask=true` requires contacts:read_identifiers and records a RESTRICTED_DATA_READ entry of its own. Required scope: `audit:read`.

Parameters

Parameters
NameTypeRequiredDescription
actionquery · string (max 64 chars)
actorRefquery · string (max 256 chars)
resourceRefquery · string (max 256 chars)Entries about this resource, including read-access entries that exposed it (a contact's messages, a conversation's thread).
sincequery · string (date-time)
untilquery · string (date-time)
unmaskquery · boolean
limitquery · integer (1–100)
cursorquery · string (max 2048 chars)
ACpath · string (AC… SID)yesAccount SID

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Current tamper-evidence chain head for the account

GET /v1/accounts/{AC}/audit/chain-head

The head hash an auditor compares against the hourly Object-Locked export anchor. Required scope: `audit:read`.

Parameters

Parameters
NameTypeRequiredDescription
ACpath · string (AC… SID)yesAccount SID

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.