Hanzo
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

Addresshttps://api.hanzo.ai/v1/compliance/records
MethodGET
Operationget_compliance_records
AuthAuthorization: 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.

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

Response

StatusBodyMeaning
200recordListok

200 body — 24 fields.

FieldInTypeAlwaysDescription
accreditationbodyaccView[]Accreditation is the org's tracked accreditation-state records.
accreditation[].basisbodystringBasis is the qualification category: income, net_worth, professional_license, or entity.
accreditation[].createdAtbodyintegerCreatedAt is the unix second the record was created.
accreditation[].evidenceDocIdbodystringEvidenceDocID references an evidence document in the org's sealed data room.
accreditation[].expiresAtbodyintegerExpiresAt is the unix second a confirmation ages out; 0 means none.
accreditation[].idbodystringID is the accreditation record's opaque id.
accreditation[].methodbodystringMethod is how the state was established: self_attested, third_party_letter, or provider_verified.
accreditation[].notebodystringNote is a non-PII operator note.
accreditation[].reviewerSubbodystringReviewerSub is the org user who recorded a decision on this record.
accreditation[].statusbodystringStatus is the tracked state: asserted, provider_verified, reviewer_confirmed, rejected, or expired.
accreditation[].subjectIdbodystringSubjectID is the opaque id of the subject the record is about.
accreditation[].updatedAtbodyintegerUpdatedAt is the unix second the record last changed.
disclaimerbodystringDisclaimer states that statuses are provider-reported or tracked, never a platform assertion of legal or regulatory compliance.
verificationsbodycheckView[]Verifications is the org's KYC/KYB checks, provider-reported statuses only.
verifications[].createdAtbodyintegerCreatedAt is the unix second the verification was started.
verifications[].decidedAtbodyintegerDecidedAt is the unix second a terminal status was recorded.
verifications[].decidedBybodystringDecidedBy records who settled a terminal status: the provider name, or a reviewer's user id for a recorded manual decision.
verifications[].idbodystringID is the verification's opaque id.
verifications[].kindbodystringKind is the party type: "individual" (KYC) or "business" (KYB).
verifications[].providerbodystringProvider is the verification provider this check runs through.
verifications[].statusbodystringStatus is the check's state: pending, provider_verified, provider_rejected, manual_review, or expired (provider-reported), or reviewer_confirmed — the one…
verifications[].subjectIdbodystringSubjectID is the opaque id of the subject under verification.
verifications[].updatedAtbodyintegerUpdatedAt is the unix second the verification last changed.
verifications[].verifyUrlbodystringVerifyURL is the provider's hosted verification flow for the subject, when one exists.

Failure carries the platform error shape — see Errors.

Examples

hanzo compliance records

Compliance API · All Hanzo APIs · Interactive reference

How is this guide?

On this page