Hanzo
OpenapiCompliance

Returns one verification — its opaque subject reference and provider-reported…

Returns one verification — its opaque subject reference and provider-reported status, no subject PII.

GET /v1/compliance/verifications/{id}

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

Returns one verification — its opaque subject reference and provider-reported status, no subject PII.

Request

1 field.

FieldInTypeRequiredDescription
idpathstringyesID is the verification to act on, from the path.

Response

StatusBodyMeaning
200checkViewok

200 body — 10 fields.

FieldInTypeAlwaysDescription
createdAtbodyintegerCreatedAt is the unix second the verification was started.
decidedAtbodyintegerDecidedAt is the unix second a terminal status was recorded.
decidedBybodystringDecidedBy records who settled a terminal status: the provider name, or a reviewer's user id for a recorded manual decision.
idbodystringID is the verification's opaque id.
kindbodystringKind is the party type: "individual" (KYC) or "business" (KYB).
providerbodystringProvider is the verification provider this check runs through.
statusbodystringStatus is the check's state: pending, provider_verified, provider_rejected, manual_review, or expired (provider-reported), or reviewer_confirmed — the one…
subjectIdbodystringSubjectID is the opaque id of the subject under verification.
updatedAtbodyintegerUpdatedAt is the unix second the verification last changed.
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 verifications get <id>

Compliance API · All Hanzo APIs · Interactive reference

How is this guide?

On this page