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
| Address | https://api.hanzo.ai/v1/compliance/subjects |
| Method | GET |
| Operation | get_compliance_subjects |
| Auth | Authorization: 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.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
limit | query | integer | — | Limit caps the rows returned; non-positive means the server default. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | subjectList | ok |
200 body — 6 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | subjectSummary[] | — | Data is the org's subjects, newest first, without contact PII. |
data[].createdAt | body | integer | — | CreatedAt is the unix second the subject was recorded. |
data[].hasEmail | body | boolean | — | HasEmail reports whether a contact email is on file, without exposing it. |
data[].id | body | string | — | ID is the subject's opaque id. |
data[].kind | body | string | — | Kind is the party type: "individual" (KYC) or "business" (KYB). |
data[].ref | body | string | — | Ref is the org's own opaque external id for this subject. |
Failure carries the platform error shape — see Errors.
Examples
hanzo compliance subjects listimport { Configuration, ComplianceApi } from 'hanzoai';
const api = new ComplianceApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getComplianceSubjects();from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import ComplianceApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = ComplianceApi(client).get_compliance_subjects()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.ComplianceAPI.GetComplianceSubjects(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, compliance_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = compliance_api::get_compliance_subjects(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.ComplianceApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new ComplianceApi(client).getComplianceSubjects();curl https://api.hanzo.ai/v1/compliance/subjects \
-H "Authorization: Bearer $HANZO_API_KEY"The door reaches compliance through the compliance tool, which names its 17 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "describe",
"arguments": {
"op": "get_compliance_accreditation"
}
}
}'How is this guide?