Hanzo
OpenapiTrust

Reads coverage: per framework, how many clauses have an automated control…

Reads coverage: per framework, how many clauses have an automated control behind them, how many are partial, and how many have none — each carrying the…

GET /v1/trust/coverage

Addresshttps://api.hanzo.ai/v1/trust/coverage
MethodGET
Operationget_trust_coverage
AuthAuthorization: Bearer $HANZO_API_KEY

Reads coverage: per framework, how many clauses have an automated control behind them, how many are partial, and how many have none — each carrying the unit it is counted in, because "12 of 20" is not a fact until you know what the 20 are.

Nothing here is a verdict. There is no boolean, and a control that only a person has read counts one rung weaker than it claims to be, because only a check that can FAIL is evidence.

Request

GET /v1/trust/coverage takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200trustCoverageok

200 body — 22 fields.

FieldInTypeAlwaysDescription
controlsbodytrustTally
controls.absentbodyintegerAbsent is how many the organization does not have.
controls.automatedbodyintegerAutomated is how many run with nobody in the loop.
controls.partialbodyintegerPartial is how many run but do not cover their whole claim.
controls.statementbodystringStatement is the counts as one sentence, safe to quote.
controls.totalbodyintegerTotal is how many controls this organization publishes.
controls.unverifiedbodyintegerUnverified is how many rest on somebody having READ the source rather than on a test or an audit row.
frameworksbodycoverRow[]Frameworks is the per-framework counts.
frameworks[].automatedbodyintegerAutomated is how many clauses have an automated control behind them that something can fail on behalf of.
frameworks[].editionbodystringEdition is which edition the clause list is taken from.
frameworks[].frameworkbodystringFramework is the framework id — "soc2", "iso27001", "nist80053".
frameworks[].namebodystringName is the published standard's name.
frameworks[].nonebodyintegerNone is how many have nothing behind them.
frameworks[].notebodystringNote is what the clause list itself is scoped to, when the framework's catalog says something a count alone would misrepresent.
frameworks[].partialbodyintegerPartial is how many are answered in part.
frameworks[].publisherbodystringPublisher is who publishes it — AICPA, ISO/IEC, NIST.
frameworks[].statementbodystringStatement is the counts as one sentence, carrying the unit.
frameworks[].totalbodyintegerTotal is the framework's WHOLE published clause list — the denominator.
frameworks[].unitbodystringUnit is what ONE clause is — "criterion", "control", "family".
frameworks[].unitsbodystringUnits is the plural of Unit, for rendering a sentence.
generatedbodyintegerGenerated is when this was computed, unix milliseconds.
versionbodystringVersion is the embedded inventory's version.

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.


Trust API · All Hanzo APIs · Interactive reference

How is this guide?

On this page