Hanzo
OpenapiCompliance

Returns one tracked accreditation record.

Returns one tracked accreditation record.

GET /v1/compliance/accreditation/{id}

Addresshttps://api.hanzo.ai/v1/compliance/accreditation/{id}
MethodGET
Operationget_compliance_accreditation_by_id
AuthAuthorization: Bearer $HANZO_API_KEY

Returns one tracked accreditation record.

Request

1 field.

FieldInTypeRequiredDescription
idpathstringyesID is the accreditation record to read, from the path.

Response

StatusBodyMeaning
200accViewok

200 body — 11 fields.

FieldInTypeAlwaysDescription
basisbodystringBasis is the qualification category: income, net_worth, professional_license, or entity.
createdAtbodyintegerCreatedAt is the unix second the record was created.
evidenceDocIdbodystringEvidenceDocID references an evidence document in the org's sealed data room.
expiresAtbodyintegerExpiresAt is the unix second a confirmation ages out; 0 means none.
idbodystringID is the accreditation record's opaque id.
methodbodystringMethod is how the state was established: self_attested, third_party_letter, or provider_verified.
notebodystringNote is a non-PII operator note.
reviewerSubbodystringReviewerSub is the org user who recorded a decision on this record.
statusbodystringStatus is the tracked state: asserted, provider_verified, reviewer_confirmed, rejected, or expired.
subjectIdbodystringSubjectID is the opaque id of the subject the record is about.
updatedAtbodyintegerUpdatedAt is the unix second the record last changed.

Failure carries the platform error shape — see Errors.

Examples

hanzo compliance accreditation get <id>

Compliance API · All Hanzo APIs · Interactive reference

How is this guide?

On this page