OpenapiCompliance
ListRecords is the unified compliance-record view for the org: its…
ListRecords is the unified compliance-record view for the org: its verifications and accreditation records together, each provider-reported or tracked,…
GET /v1/compliance/records
| Address | https://api.hanzo.ai/v1/compliance/records |
| Method | GET |
| Operation | get_compliance_records |
| Auth | Authorization: Bearer $HANZO_API_KEY |
ListRecords is the unified compliance-record view for the org: its verifications and accreditation records together, each provider-reported or tracked, never platform-asserted. PII stays in the subject store; records carry only opaque ids and statuses.
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 | recordList | ok |
200 body — 24 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
accreditation | body | accView[] | — | Accreditation is the org's tracked accreditation-state records. |
accreditation[].basis | body | string | — | Basis is the qualification category: income, net_worth, professional_license, or entity. |
accreditation[].createdAt | body | integer | — | CreatedAt is the unix second the record was created. |
accreditation[].evidenceDocId | body | string | — | EvidenceDocID references an evidence document in the org's sealed data room. |
accreditation[].expiresAt | body | integer | — | ExpiresAt is the unix second a confirmation ages out; 0 means none. |
accreditation[].id | body | string | — | ID is the accreditation record's opaque id. |
accreditation[].method | body | string | — | Method is how the state was established: self_attested, third_party_letter, or provider_verified. |
accreditation[].note | body | string | — | Note is a non-PII operator note. |
accreditation[].reviewerSub | body | string | — | ReviewerSub is the org user who recorded a decision on this record. |
accreditation[].status | body | string | — | Status is the tracked state: asserted, provider_verified, reviewer_confirmed, rejected, or expired. |
accreditation[].subjectId | body | string | — | SubjectID is the opaque id of the subject the record is about. |
accreditation[].updatedAt | body | integer | — | UpdatedAt is the unix second the record last changed. |
disclaimer | body | string | — | Disclaimer states that statuses are provider-reported or tracked, never a platform assertion of legal or regulatory compliance. |
verifications | body | checkView[] | — | Verifications is the org's KYC/KYB checks, provider-reported statuses only. |
verifications[].createdAt | body | integer | — | CreatedAt is the unix second the verification was started. |
verifications[].decidedAt | body | integer | — | DecidedAt is the unix second a terminal status was recorded. |
verifications[].decidedBy | body | string | — | DecidedBy records who settled a terminal status: the provider name, or a reviewer's user id for a recorded manual decision. |
verifications[].id | body | string | — | ID is the verification's opaque id. |
verifications[].kind | body | string | — | Kind is the party type: "individual" (KYC) or "business" (KYB). |
verifications[].provider | body | string | — | Provider is the verification provider this check runs through. |
verifications[].status | body | string | — | Status is the check's state: pending, provider_verified, provider_rejected, manual_review, or expired (provider-reported), or reviewer_confirmed — the one… |
verifications[].subjectId | body | string | — | SubjectID is the opaque id of the subject under verification. |
verifications[].updatedAt | body | integer | — | UpdatedAt is the unix second the verification last changed. |
verifications[].verifyUrl | body | string | — | VerifyURL is the provider's hosted verification flow for the subject, when one exists. |
Failure carries the platform error shape — see Errors.
Examples
hanzo compliance recordsimport { Configuration, ComplianceApi } from 'hanzoai';
const api = new ComplianceApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getComplianceRecords();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_records()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.ComplianceAPI.GetComplianceRecords(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_records(&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).getComplianceRecords();curl https://api.hanzo.ai/v1/compliance/records \
-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?