Skip to content

Audit

An Audit is one engagement with an outside firm: the namespaces in scope, the Criteria, the report period, and the firm’s Attestation.

Properties

PropertyTypeRequiredDescription
firmOrganizationrequiredThe licensed firm that performs the engagement.
criterialist of CriterionrequiredThe Criteria in scope.
typestringrequiredOne of type1 (one date) or type2 (a range).
fromdatetimerequiredThe first day of the report period; never before the namespace’s first Event.
todatetimerequiredThe last day of the report period.
seedstringrequiredThe sampling seed, committed before the period ends.
attestationAttestationThe firm’s signed opinion.

Object

JSON
{
  "$id": "https://api.sb/patentpad.com/audits/audit_1",
  "$type": "Audit",
  "firm": "organization_1",
  "criteria": [
    "criterion_1"
  ],
  "type": "Example type",
  "from": "2026-10-22T12:00:00Z",
  "to": "2026-10-22T12:00:00Z",
  "seed": "Example seed",
  "attestation": "attestation_1"
}

Relationships

  • An Audit relies on many Proofs: the Proofs the auditing firm samples across the report period. reliesOn, inverse reliedOnBy.

Verbs

  1. getReturns one Audit by id.
    GET /{namespace}/audits/{id}readNo Event
  2. listReturns Audits, newest first, one page at a time.
    GET /{namespace}/auditsreadNo Event

An Audit is kept forever and never edited: it has no update or delete.

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operationowneradminmemberviewer
Audit.getYesYesYesYes
Audit.listYesYesYesYes

Call it

Text
Show me the latest audit.

Example

A firm signs an engagement letter for a type 2 report over the first six months of the year. Signing creates the Audit, opens the firm's read-only namespace, and commits the sampling seed.