Docs/Reference/Shareholdings/Get Shareholding Audit
GET/v1/shareholdings/{shareholding_id}/auditTier · Institutional

Get Shareholding Audit

Full audit bundle for a single shareholding row.

Returns the row's classification with the full provenance chain: real-time view (knowable at filing time), retrospective view (revealed by later evidence on the same filer × issuer pair), confidence + alternative for both, the source filing reference, and a stable classifier version stamp consumers can pin to.

To freeze a response: capture meta.as_of from one call, then pass it back as ?as_of=<token> on later calls: you'll get the same answer regardless of how the data has evolved. Two calls that share the same as_of are guaranteed bit-identical.

Path parameters · 1

Variables interpolated into the URL path.

shareholding_idintegerrequired

Row id from /companies/{code}/shareholdings.

Query parameters · 1

Optional filters and modifiers. Pass as URL-encoded ?key=value.

as_ofstring | nulloptional

Freeze the response to a specific point in time. Pass a value previously returned in meta.as_of to replay the exact same answer. Omit for the live view.

Request headers · 1

Authentication.

Authorizationstringrequired

Production API key. Pass it as Bearer ax_live_…

Returns · 200

The standard { data, meta } envelope. data contains ShareholdingAuditOut.

Envelope

dataShareholdingAuditOut

A single result object.

metaMeta

Pagination and request metadata, including request_id, data_as_of, and ontology_version.

ontology_version 2.1.0replay meta.as_of · ?as_of=<token>

ShareholdingAuditOut

shareholding_idinteger

Row identifier.

sourceobject

Filing reference. Includes doc_id (EDINET), filer EDINET code, issuer security code, and base_date. Every claim in this bundle traces to this filing.

realtimeobject

What was knowable at filing time. Includes predicted_category (= holding_purpose_category), confidence, alternative_label + probability, validated, as_of_date (= source.base_date).

retrospectiveobject | null

What later evidence revealed. Same shape as realtime but predicted_category may differ when later filings from the same filer × issuer disclosed a more-active intent. evidence_cutoff_date marks the latest filing used. Null when no later evidence existed.

classifier_versionstring | null

Opaque label for the classifier configuration applied to this row.

Errors

Standard HTTP status codes plus a typed error.code in the { error: { code, message } } envelope.

Every endpoint returns the same typed error envelope ({ error: { code, message } }). For the full list of codes, see the Errors reference.