Playground

Playground

PolicyAcknowledgement

/api/v1/policies/acknowledgements

Records that a person has read and agreed to a specific version of a policy.

listgetcreatedelete

Schema

FieldTypeNotes
id*uuidServer-assigned ULID with type prefix (e.g. per_…).
tenant_id*stringTenant scope — auto-stamped from the caller's JWT.
app_idstringApp scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*date-timeServer stamp.
updated_at*date-timeServer stamp; updated on every patch.
created_byuuidFK → UserUser id from the caller's JWT (sub).
updated_byuuidFK → UserUser id from the last writer's JWT (sub).
sourcestringProvenance tag — defaults to 'edm'.
source_typeenumfrontend | backend | server | system | apiWhere the write originated. Defaults to 'api'.
is_deletedbooleanSoft-delete flag. Excluded from default list queries.
deleted_atdate-timeStamped when soft-deleted; null otherwise.
deleted_byuuidFK → UserUser id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
policy_id*uuidFK → PolicyThe policy being acknowledged.
person_id*uuidFK → PersonWho acknowledged the policy.
policy_versionstringVersion of the policy at the time of acknowledgement (snapshot).
acknowledged_atdate-timeISO 8601 timestamp when the user clicked 'I agree'.
ip_addressstringSource IP address for stronger audit trail.
user_agentstringUser-Agent of the browser/client at acknowledgement time.

API

client.policies.acknowledgements.*
Loading manifest…