Skip to content

Compliance Coverage

GET
/compliance/coverage

The materialized coverage read model for one adopted framework version, in one call (ADR-0015): each applicable requirement with its serving control, weakest-wins status, contributing resource bindings, evidence count, any risk acceptance, and per-row staleness. Reads projections, never recomputes.

ADR-0023: aws_account_id selects that account’s rollup rows in the same shape. Without it, unrestricted callers get the tenant-level rollup; account-restricted callers get their single account’s rollup, or the named 400 when they reach several, the tenant aggregate is never served to them.

tenant_id
required
Tenant Id
string format: uuid
framework_version
required
Framework Version
string
aws_account_id
Any of:
string format: uuid
st_session
Any of:
string

Successful Response

CoverageResponse
object
active_job
Any of:
object
key
additional properties
any
categories
required
Categories
Array<object>
CoverageCategory

One control-category filter for this framework’s matrix (A63). Served rather than derived client-side so the label, the order, and the count come from the catalog the coverage rows were built from.

object
count
required
Count
integer
key
required
Key
string
label
required
Label
string
category_axis_label
required
Category Axis Label
string
framework
required
Framework
string
framework_version
required
Framework Version
string
refreshed_at
required
Any of:
string format: date-time
requirements
required
Requirements
Array<object>
CoverageRequirement
object
attestation_document_id
required
Any of:
string format: uuid
bindings
required
Bindings
Array<object>
CoverageBinding
object
contribution
required
Contribution
string
data_classification
required
Data Classification
string
resource
required
Resource
string
resource_type
required
Resource Type
string
caveats
required
Caveats
Array<string>
contributor_count
required
Contributor Count
integer
contributors
required
Contributors
Array<object>
CoverageContributor

One thing that must be satisfied for a requirement, the strict roll-up made legible.

kind is control (something the platform deploys, evaluates, or inherits) or attestation (the one document covering what no control reaches). state is the per-contributor vocabulary (satisfied / inherited / attested / partial / unsatisfied / unreachable), distinct from the requirement’s rollup_status.

object
absorbed_controls
required
Absorbed Controls
Array<string>
control_key
required
Any of:
string
kind
required
Kind
string
name
required
Name
string
reachable_via
required
Reachable Via
string
reasons
required
Reasons
Array<string>
resources
required
Resources
Array<object>
object
key
additional properties
any
state
required
State
string
control_key
required
Any of:
string
drift_findings
required
Drift Findings
Array<object>
CoverageDriftFinding
object
control_key
required
Any of:
string
finding_id
required
Finding Id
string format: uuid
resource
required
Resource
string
summary
required
Summary
string
evidence_count
required
Evidence Count
integer
excluded_count
required
Excluded Count
integer
nature
required
Any of:
string
obligation
required
Any of:
string
requirement_category
required
Requirement Category
string
requirement_category_label
required
Requirement Category Label
string
requirement_code
required
Requirement Code
string
requirement_coverage
required
Requirement Coverage
string
requirement_title
required
Requirement Title
string
risk_acceptance
required
Any of:
object
key
additional properties
any
rollup_status
required
Rollup Status
string
satisfied_count
required
Satisfied Count
integer
stale_since
required
Any of:
string format: date-time
tenant_id
required
Tenant Id
string format: uuid
totals
required
Totals
object
key
additional properties
integer

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string