Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt

Use this file to discover all available pages before exploring further.

Generates an aggregated compliance report for an entity across all checks performed within a specified time period. Reports provide executive-level summaries, trend analysis, and a consolidated view of all findings — suitable for sharing with auditors, compliance officers, and regulators. Reports are generated asynchronously for large time ranges. For periods under 30 days, results are typically returned synchronously.

Authentication

Requires X-API-Key header or Bearer JWT token. Tenant-scoped via X-Tenant-ID.

Request Body

entity_type
string
required
The type of entity to report on. One of: agent, model, dataset, workflow.
entity_id
string
required
The unique identifier of the entity.
regulation
string
required
The regulation or framework to report against. Supported values: SOC2, ISO27001, GDPR, HIPAA, EU_AI_ACT.
period_start
string
required
ISO 8601 date for the start of the reporting period (inclusive). Example: 2026-01-01.
period_end
string
required
ISO 8601 date for the end of the reporting period (inclusive). Example: 2026-03-31.

Response

id
string
Unique identifier for the compliance report. Format: maip-report:ULID.
entity_type
string
The type of entity reported on.
entity_id
string
The identifier of the entity reported on.
regulation
string
The regulation assessed.
period_start
string
Start of the reporting period.
period_end
string
End of the reporting period.
status
string
Report generation status. One of: generating, ready, failed.
summary
object
High-level summary of compliance across the reporting period.
findings
object[]
Aggregated findings across all checks in the period. Deduplicated by control ID with the most recent status.
generated_at
string
ISO 8601 timestamp of when the report was generated.