List label

Reads the assertions this tenant has recorded, newest event first.

GET /v1/label

Addresshttps://api.hanzo.ai/v1/label
MethodGET
OperationriskLabels
AuthAuthorization: Bearer $HANZO_API_KEY

Reads the assertions this tenant has recorded, newest event first.

It reads the RECORD — the tenant's own store — and not the columnar copy, so what it returns is what would be produced in an audit. Narrow it by entity, by asserter, or by event window.

Request

6 fields.

FieldInTypeRequiredDescription
kindquerystring—Kind and Subject narrow to one entity.
subjectquerystring—
sourcequerystring—Source narrows to one asserter — the read that answers "what has commerce told us", separately from "what has an analyst told us".
fromquerystring—From and To bound the EVENT time, half-open, RFC 3339.
toquerystring—
limitqueryinteger—Limit caps the page.

Response

StatusBodyMeaning
200label.riskLabelsOutok
defaultproblem-detailsrefused

200 body — 15 fields.

FieldInTypeAlwaysDescription
countbodyinteger (int64)—Count is how many this page holds.
labelsbodylabel.riskLabelRecord[]—Labels is the page, newest event first.
labels[].atbodystring—At is when the judged EVENT happened, RFC 3339 in UTC, truncated to the second.
labels[].bybodystring—By is the identity that asserted, stamped server-side at the write.
labels[].confidencebodynumber (double)—Confidence is the filer's own confidence in [0,1] — 1 for a processor chargeback, less for an analyst's hunch.
labels[].dispositionbodystring—Disposition is what was concluded, from the closed set: productive — the event led somewhere, escalated, reported or charged back; unproductive — judged not suspicious; or the empty string for an explicit UNJUDGED, which is a real assertion ("we looked and could not say") and not the absence of one.
labels[].evidencebodystring—Evidence is the pointer to the record this conclusion came from: a dispute id, a case id, a decision id.
labels[].holdbodyboolean—Hold is true while a litigation hold is on this record: retention will not dispose of it, at any age.
labels[].idbodystring—ID is the assertion's content digest — SHA-256 over every semantic field, rendered hex — computed server-side and never supplied.
labels[].kindbodystring—Kind is what the subject IS, from the closed set: account, agent, merchant, payout, person, session or transaction.
labels[].knowablebodystring—Knowable is when THIS PLANE could first have answered with the assertion: the later of Seen and the server clock at the write, derived server-side.
labels[].seenbodystring—Seen is when the FILER said the assertion became knowable.
labels[].sourcebodystring—Source is WHO asserted, from the closed set: chargeoff, dispute, case, refund, review or sample.
labels[].subjectbodystring—Subject is the entity that was judged, named in the TENANT'S OWN namespace and at most 512 bytes.
labels[].wrotebodystring—Wrote is the server clock at the write.

Failure carries the platform error shape — see Errors.

Examples

hanzo label get
import { Configuration, LabelApi } from 'hanzoai';

const api = new LabelApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.riskLabels();
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import LabelApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = LabelApi(client).risk_labels()
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.LabelAPI.RiskLabels(context.Background()).Execute()
if err != nil {
	return err
}
use hanzo_client::apis::{configuration::Configuration, label_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = label_api::risk_labels(&cfg, Default::default()).await?;
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.LabelApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new LabelApi(client).riskLabels();
curl https://api.hanzo.ai/v1/label \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool label, op riskLabels — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "label",
         "arguments": {
           "op": "riskLabels",
           "input": {}
         }
       }
     }'

Label API · All Hanzo APIs · Interactive reference

Was this page useful?