> ## 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.

# Generate Compliance Report

> Generate a comprehensive compliance report for an entity over a time period

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

<ParamField body="entity_type" type="string" required>
  The type of entity to report on. One of: `agent`, `model`, `dataset`,
  `workflow`.
</ParamField>

<ParamField body="entity_id" type="string" required>
  The unique identifier of the entity.
</ParamField>

<ParamField body="regulation" type="string" required>
  The regulation or framework to report against. Supported values: `SOC2`,
  `ISO27001`, `GDPR`, `HIPAA`, `EU_AI_ACT`.
</ParamField>

<ParamField body="period_start" type="string" required>
  ISO 8601 date for the start of the reporting period (inclusive). Example:
  `2026-01-01`.
</ParamField>

<ParamField body="period_end" type="string" required>
  ISO 8601 date for the end of the reporting period (inclusive). Example:
  `2026-03-31`.
</ParamField>

### Response

<ResponseField name="id" type="string">
  Unique identifier for the compliance report. Format: `maip-report:ULID`.
</ResponseField>

<ResponseField name="entity_type" type="string">
  The type of entity reported on.
</ResponseField>

<ResponseField name="entity_id" type="string">
  The identifier of the entity reported on.
</ResponseField>

<ResponseField name="regulation" type="string">
  The regulation assessed.
</ResponseField>

<ResponseField name="period_start" type="string">
  Start of the reporting period.
</ResponseField>

<ResponseField name="period_end" type="string">
  End of the reporting period.
</ResponseField>

<ResponseField name="status" type="string">
  Report generation status. One of: `generating`, `ready`, `failed`.
</ResponseField>

<ResponseField name="summary" type="object">
  High-level summary of compliance across the reporting period.

  <Expandable title="Summary fields">
    <ResponseField name="summary.total_checks" type="integer">
      Total number of compliance checks performed in the period.
    </ResponseField>

    <ResponseField name="summary.compliant" type="integer">
      Number of checks that returned `compliant`.
    </ResponseField>

    <ResponseField name="summary.non_compliant" type="integer">
      Number of checks that returned `non_compliant`.
    </ResponseField>

    <ResponseField name="summary.partial" type="integer">
      Number of checks that returned `partial`.
    </ResponseField>

    <ResponseField name="summary.compliance_rate" type="number">
      Percentage of checks that returned `compliant`, as a float between `0.0` and `100.0`.
    </ResponseField>

    <ResponseField name="summary.trend" type="string">
      Compliance trend direction over the period: `improving`, `stable`, `degrading`.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="findings" type="object[]">
  Aggregated findings across all checks in the period. Deduplicated by control ID with the most recent status.

  <Expandable title="Finding fields">
    <ResponseField name="findings[].control_id" type="string">
      The control identifier within the regulation.
    </ResponseField>

    <ResponseField name="findings[].control_name" type="string">
      Human-readable name of the control.
    </ResponseField>

    <ResponseField name="findings[].current_status" type="string">
      Most recent status: `pass`, `fail`, `partial`, `not_applicable`.
    </ResponseField>

    <ResponseField name="findings[].severity" type="string">
      Severity if not passing: `critical`, `high`, `medium`, `low`.
    </ResponseField>

    <ResponseField name="findings[].first_detected" type="string">
      ISO 8601 timestamp of when this finding first appeared.
    </ResponseField>

    <ResponseField name="findings[].last_checked" type="string">
      ISO 8601 timestamp of the most recent check for this control.
    </ResponseField>

    <ResponseField name="findings[].description" type="string">
      Detailed description and remediation guidance.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="generated_at" type="string">
  ISO 8601 timestamp of when the report was generated.
</ResponseField>


## OpenAPI

````yaml mint-openapi.yaml GET /v1/compliance/reports
openapi: 3.0.3
info:
  title: Truthlocks API
  description: >
    Truthlocks is a universal verification infrastructure for documents,
    credentials, and digital assets.

    This specification defines the canonical API for interacting with Truthlocks
    services.


    ## Base URLs

    - **Production**: `https://api.truthlocks.com`

    - **Sandbox**: `https://sandbox-api.truthlocks.com`


    ## Authentication

    - **API Keys**: Use `X-API-Key` header for machine-to-machine operations

    - **Bearer Tokens**: Use `Authorization: Bearer <jwt>` for user-initiated
    operations


    ## Tenant Identity

    In production, tenant identity is derived from the authenticated context
    (API key or JWT).

    The `X-Tenant-ID` header is ignored in production to prevent spoofing.
  version: 1.0.0
  contact:
    name: Truthlocks Support
    url: https://truthlocks.com/support
    email: support@truthlocks.com
servers:
  - url: https://api.truthlocks.com
    description: Production API
  - url: https://sandbox-api.truthlocks.com
    description: Sandbox Environment
security:
  - APIKey: []
tags:
  - name: Authentication
    description: API key and token management
  - name: Issuers
    description: Issuer registration and trust management
  - name: Keys
    description: Cryptographic key management for issuers
  - name: Attestations
    description: Attestation lifecycle (mint, revoke, supersede)
  - name: Verification
    description: Attestation verification and proof bundles
  - name: Governance
    description: Issuer governance workflows (admin only)
  - name: Identity
    description: Organization, user, and role management
  - name: Audit
    description: Audit event queries
  - name: Platform
    description: Platform administration (super admin only)
  - name: Platform Review
    description: Staff review workflows for issuer applications
  - name: Tenant Console
    description: Tenant profile and lifecycle endpoints
  - name: Health
    description: Service health and readiness endpoints
  - name: Risk
    description: Risk signal ingestion and fraud detection
  - name: Risk Enforcement
    description: Risk enforcement actions — block, challenge, quarantine, and configuration
  - name: Billing
    description: Billing, subscription, and addon management
  - name: Machine Identity
    description: >-
      Machine Agent Identity Protocol (MAIP) — agent registration, sessions,
      trust, witness, compliance, orchestration, and observability
externalDocs:
  description: Transparency read-only API (separate service spec)
  url: >-
    https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
  /v1/compliance/reports:
    get:
      tags:
        - Machine Identity
      summary: List Compliance Reports
      description: >-
        Returns a paginated list of compliance reports filtered by optional
        criteria.
      operationId: maip.compliance.reports.list
      parameters:
        - name: agent_id
          in: query
          schema:
            type: string
            format: uuid
          description: Filter by agent
        - name: framework
          in: query
          schema:
            type: string
            enum:
              - soc2
              - iso27001
              - hipaa
              - gdpr
          description: Filter by framework
        - name: status
          in: query
          schema:
            type: string
            enum:
              - pending
              - passed
              - failed
              - partial
          description: Filter by result status
        - name: limit
          in: query
          schema:
            type: integer
            default: 25
            minimum: 1
            maximum: 100
        - name: offset
          in: query
          schema:
            type: integer
            default: 0
            minimum: 0
      responses:
        '200':
          description: Paginated compliance reports
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MaipComplianceReportList'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - APIKey: []
components:
  schemas:
    MaipComplianceReportList:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/MaipComplianceCheck'
        total:
          type: integer
    ErrorEnvelope:
      type: object
      required:
        - code
        - message
        - http_status
      properties:
        code:
          type: string
          description: Machine-readable error code
          enum:
            - AUTH_REQUIRED
            - AUTH_INVALID
            - PERMISSION_DENIED
            - TENANT_IDENTITY_UNVERIFIED
            - NOT_FOUND
            - VALIDATION_ERROR
            - CONFLICT
            - PAYLOAD_TOO_LARGE
            - RATE_LIMIT_EXCEEDED
            - QUOTA_EXCEEDED
            - SERVICE_UNAVAILABLE
            - INTERNAL_ERROR
        message:
          type: string
          description: Human-readable error message
        http_status:
          type: integer
          description: HTTP status code
        retry_after_ms:
          type: integer
          description: Milliseconds to wait before retrying (for rate limits)
        details:
          type: object
          description: Additional error context
      example:
        code: AUTH_REQUIRED
        message: Authentication required
        http_status: 401
    MaipComplianceCheck:
      type: object
      properties:
        check_id:
          type: string
          format: uuid
        agent_id:
          type: string
          format: uuid
        framework:
          type: string
          enum:
            - soc2
            - iso27001
            - hipaa
            - gdpr
        scope:
          type: object
          additionalProperties: true
        status:
          type: string
          enum:
            - pending
            - passed
            - failed
            - partial
        findings:
          type: array
          items:
            type: object
            properties:
              finding_id:
                type: string
              severity:
                type: string
                enum:
                  - low
                  - medium
                  - high
                  - critical
              title:
                type: string
              description:
                type: string
        created_at:
          type: string
          format: date-time
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for machine-to-machine authentication

````