Hanzo
OpenapiCompliance

Returns the org's subjects as PII-MINIMIZED summaries — no name or email, only…

Returns the org's subjects as PII-MINIMIZED summaries — no name or email, only whether an email is on file.

GET /v1/compliance/subjects

Addresshttps://api.hanzo.ai/v1/compliance/subjects
MethodGET
Operationget_compliance_subjects
AuthAuthorization: Bearer $HANZO_API_KEY

Returns the org's subjects as PII-MINIMIZED summaries — no name or email, only whether an email is on file. The full record is returned only by the explicit single-subject read.

Request

1 field.

FieldInTypeRequiredDescription
limitqueryintegerLimit caps the rows returned; non-positive means the server default.

Response

StatusBodyMeaning
200subjectListok

200 body — 6 fields.

FieldInTypeAlwaysDescription
databodysubjectSummary[]Data is the org's subjects, newest first, without contact PII.
data[].createdAtbodyintegerCreatedAt is the unix second the subject was recorded.
data[].hasEmailbodybooleanHasEmail reports whether a contact email is on file, without exposing it.
data[].idbodystringID is the subject's opaque id.
data[].kindbodystringKind is the party type: "individual" (KYC) or "business" (KYB).
data[].refbodystringRef is the org's own opaque external id for this subject.

Failure carries the platform error shape — see Errors.

Examples

hanzo compliance subjects list

Compliance API · All Hanzo APIs · Interactive reference

How is this guide?

On this page