Reads one framework clause by clause: every clause the standard publishes, what…

Reads one framework clause by clause: every clause the standard publishes, what covers it, and which controls stand behind it — so a coverage number can…

GET /v1/trust/coverage/{framework}

Trust → · All API references → · Six flows, four surfaces →


Address	`https://api.hanzo.ai/v1/trust/coverage/{framework}`
Method	`GET`
Operation	`get_trust_coverage_by_framework`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Reads one framework clause by clause: every clause the standard publishes, what covers it, and which controls stand behind it — so a coverage number can be checked line by line rather than taken on trust.

Request

1 field.

Field	In	Type	Required	Description
`framework`	path	string	yes	Framework is the framework id — "soc2", "iso27001", "nist80053".

Response

Status	Body	Meaning
`200`	clauseCoverage	ok

200 body — 20 fields.

Field	In	Type	Always	Description
`automated`	body	integer	—	Automated is how many clauses have an automated control behind them that something can fail on behalf of.
`clauses`	body	clauseRow[]	—	Clauses is every clause the standard publishes, with what stands behind it.
`clauses[].controls`	body	string[]	—	Controls are the ids behind it, strongest first.
`clauses[].group`	body	string	—	Group is the clause's section within the standard, when it has one.
`clauses[].id`	body	string	—	ID is the clause id as the standard publishes it — "CC6.1", "A.5.15", "AC".
`clauses[].level`	body	string	—	Level is what the strongest control pointed at this clause is worth: "automated", "partial" or "none".
`clauses[].title`	body	string	—	Title is the standard's own words for that clause.
`edition`	body	string	—	Edition is which edition this clause list is taken from.
`framework`	body	string	—	Framework is the framework id — "soc2", "iso27001", "nist80053".
`generated`	body	integer	—	Generated is when this was computed, unix milliseconds.
`name`	body	string	—	Name is the published standard's name.
`none`	body	integer	—	None is how many have nothing behind them.
`note`	body	string	—	Note is what this clause list is scoped to, when a count alone would misrepresent it.
`partial`	body	integer	—	Partial is how many are answered in part.
`publisher`	body	string	—	Publisher is who publishes it — AICPA, ISO/IEC, NIST.
`statement`	body	string	—	Statement is the counts as one sentence, carrying the unit.
`total`	body	integer	—	Total is the framework's WHOLE published clause list — the denominator.
`unit`	body	string	—	Unit is what ONE clause is — "criterion", "control", "family".
`units`	body	string	—	Units is the plural of Unit, for rendering a sentence.
`version`	body	string	—	Version 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.

import { Configuration, TrustApi } from 'hanzoai';

const api = new TrustApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getTrustCoverageByFramework({ framework: 'framework' });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import TrustApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = TrustApi(client).get_trust_coverage_by_framework(framework='framework')

cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)

resp, _, err := client.TrustAPI.GetTrustCoverageByFramework(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_cloud::apis::{configuration::Configuration, trust_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = trust_api::get_trust_coverage_by_framework(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.TrustApi;

ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));

var result = new TrustApi(client).getTrustCoverageByFramework();

The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →

curl https://api.hanzo.ai/v1/trust/coverage/<framework> \
  -H "Authorization: Bearer $HANZO_API_KEY"

The door declares no tool for trust — tools/list on https://api.hanzo.ai/v1/mcp names the products it does reach. Use HTTP or an SDK.

Trust API · All Hanzo APIs · Interactive reference

Reads one framework clause by clause: every clause the standard publishes, what…

Request

Response

Examples

On this page