Records a party the org is verifying as part of its own onboarding/compliance —…
Records a party the org is verifying as part of its own onboarding/compliance — a team member, vendor, customer, or counterparty.
POST /v1/compliance/subjects
| Address | https://api.hanzo.ai/v1/compliance/subjects |
| Method | POST |
| Operation | post_compliance_subjects |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Records a party the org is verifying as part of its own onboarding/compliance — a team member, vendor, customer, or counterparty. The subject's contact PII (name/email) is sealed at rest and returned only to the owning org; downstream records reference the subject by opaque id.
Request
4 fields, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
email | body | string | — | Email is the subject's contact email, sealed at rest. |
kind | body | string | — | Kind is the party type: "individual" (KYC) or "business" (KYB). |
name | body | string | — | Name is the subject's name, sealed at rest. |
ref | body | string | — | Ref is the org's own opaque external id for this subject. |
Response
| Status | Body | Meaning |
|---|---|---|
201 | Subject | created |
201 body — 8 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
createdAt | body | integer | — | CreatedAt is when the subject was first recorded, Unix SECONDS. |
email | body | string | — | Email is the party's address, when the org supplied one. |
id | body | string | — | ID is the opaque handle every other record uses to point at this party. |
kind | body | string | — | Kind is what is being verified: "individual" (a natural person, so KYC) or "business" (a legal entity, so KYB). |
name | body | string | — | Name is the party's name, under the same PII rule as Email. |
org | body | string | — | Org is the tenant that is doing the verifying — the party who must answer for this record, not the party being verified. |
ref | body | string | — | Ref is the org's OWN identifier for this party, carried so a caller can match a subject back to their system without keeping a second mapping. |
updatedAt | body | integer | — | UpdatedAt is when the subject's own fields last changed, Unix seconds. |
Failure carries the platform error shape — see Errors.
Examples
hanzo compliance subjects createimport { Configuration, ComplianceApi } from 'hanzoai';
const api = new ComplianceApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postComplianceSubjects({ email: "<email>", kind: "<kind>" });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).post_compliance_subjects(email="<email>", kind="<kind>")cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.ComplianceAPI.PostComplianceSubjects(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::post_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).postComplianceSubjects();curl -X POST https://api.hanzo.ai/v1/compliance/subjects \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"email": "<email>",
"kind": "<kind>"
}'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?