Hanzo
OpenapiTrust

Lists your organization's documents.

Lists your organization's documents.

GET /v1/trust/documents

Addresshttps://api.hanzo.ai/v1/trust/documents
MethodGET
Operationget_trust_documents
AuthAuthorization: Bearer $HANZO_API_KEY

Lists your organization's documents. Because this is your own centre, a gated artifact carries its address here; through the published door it does not.

Request

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

Response

StatusBodyMeaning
200trustDocumentsok

200 body — 11 fields.

FieldInTypeAlwaysDescription
documentsbodydocRow[]Documents is the list; a gated entry carries no address.
documents[].attestedbodybooleanAttested reports whether somebody OUTSIDE this organization put their name to it.
documents[].hrefbodystringHref is where to read it, present only when this reader may.
documents[].idbodystringID is the document's id within this organization's centre.
documents[].kindbodystringKind is the artifact type — soc2, iso, pentest, letter, caiq, sig, vsa, questionnaire, policy or other.
documents[].labelbodystringLabel is the artifact type in words, for rendering.
documents[].notebodystringNote is anything the organization says about this artifact.
documents[].releasedbodybooleanReleased reports whether THIS reader may read it.
documents[].tierbodystringTier is "public" or "gated".
documents[].titlebodystringTitle is what the document is called.
documents[].updatedbodyintegerUpdated is when the record last changed, unix milliseconds.

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