Hanzo
OpenapiCompliance

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

Addresshttps://api.hanzo.ai/v1/compliance/subjects
MethodPOST
Operationpost_compliance_subjects
AuthAuthorization: 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).

FieldInTypeRequiredDescription
emailbodystringEmail is the subject's contact email, sealed at rest.
kindbodystringKind is the party type: "individual" (KYC) or "business" (KYB).
namebodystringName is the subject's name, sealed at rest.
refbodystringRef is the org's own opaque external id for this subject.

Response

StatusBodyMeaning
201Subjectcreated

201 body — 8 fields.

FieldInTypeAlwaysDescription
createdAtbodyintegerCreatedAt is when the subject was first recorded, Unix SECONDS.
emailbodystringEmail is the party's address, when the org supplied one.
idbodystringID is the opaque handle every other record uses to point at this party.
kindbodystringKind is what is being verified: "individual" (a natural person, so KYC) or "business" (a legal entity, so KYB).
namebodystringName is the party's name, under the same PII rule as Email.
orgbodystringOrg is the tenant that is doing the verifying — the party who must answer for this record, not the party being verified.
refbodystringRef 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.
updatedAtbodyintegerUpdatedAt is when the subject's own fields last changed, Unix seconds.

Failure carries the platform error shape — see Errors.

Examples

hanzo compliance subjects create

Compliance API · All Hanzo APIs · Interactive reference

How is this guide?

On this page