Playground

Playground

Compliance

/api/v1/legal/compliance

A legal compliance assessment against a framework.

listgetcreateupdatedelete

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_byuuidPerson id from the caller's JWT (sub).
updated_byuuidPerson 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_byuuidPerson id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
title*stringCompliance assessment title.
frameworkenumgdpr | hipaa | sox | pci_dss | iso_27001 | fedramp | otherCompliance framework.
statusenumcompliant | non_compliant | in_progress | not_assessedCompliance status.
assessed_atdate-timeISO 8601 date the assessment was performed.
assessor_idstringUser ID of the assessor.
findingsstringAssessment findings.
remediation_planstringPlan to remediate findings.
next_review_datedate-timeISO 8601 date of the next review.
control_idstringIdentifier of the compliance control (e.g. CC6.1).
descriptionstringDescription of the control.
categorystringControl category (e.g. Access Control).
ownerstringUser ID of the control owner.
evidencejsonCollected evidence supporting the control.
last_assessed_atdate-timeISO 8601 date the control was last assessed.
next_review_atdate-timeISO 8601 date of the next control review.
linked_asset_idsjsonIDs of assets linked to this control.

API

Loading manifest…