HYBRID-CHAINDEVELOPERS
DOCUMENTATIONv2
GET

Tokenized Securities

Get token inventory

/api/v2/tokens/inventory
AUTHENTICATIONBearer token · assets:readAUTHORITATIVE OWNERasset-tokenizationCONTRACT AUTHORITYCapability registry · plannedSTATUSPlanned · not executable
PLANNING CONTRACT · NOT CALLABLE

This page describes intended capability and integration boundaries so people and agents can prepare safely. Do not send this request or register it as an executable tool. Wait until the capability registry marks it implemented-contract, then re-fetch the deployed OpenAPI document and build the request from that machine contract.

PURPOSE + BUSINESS CONTEXT

Planned capability: list token inventory through the authoritative digital-asset registry service boundary.

WHEN THIS CALL IS USEFUL

Do not call or register this operation as an executable agent tool yet. Use this page to plan the future token inventory workflow; enable it only after the status becomes implemented-contract and the exact operation appears in deployed OpenAPI.

OUTCOME · Planned · Discover

What changes

None today: this route is not executable. Its intended behavior is: none. The legacy inventory path is not executable and cannot query private reserve wallets, create balances, establish holder ownership, or change supply.

WHY IT MATTERS

  • Lets people and agents prepare for token inventory without falsely presenting roadmap scope as a live capability.
  • Gives people and agents a contract-backed way to discover token inventory.
  • Lets clients verify asset identity and provenance without treating display metadata or portfolio visibility as issuance or trading authority.

ISOLATION + AUTHORITY

Issuer, collection, asset, mint, proof, owner, network, supply, metadata, custody, marketplace, and trading boundaries remain distinct. Reading an asset or proof cannot issue, mint, transfer, list, value, or trade it; current trading and matching controls remain frozen unless separately approved. This planning record grants no runtime authority, and only deployed OpenAPI can define an executable public contract.

BEFORE YOU CALL

  • First confirm that this operation is marked implemented-contract and exists in the currently deployed OpenAPI document; until then, no production request is valid.
  • Its capability-registry profile is provisional integration guidance, not an executable request schema.
  • Authenticate at the documented boundary: bearer.
  • Treat the proposed token_uuid (query) as planning input only; re-generate the request from deployed OpenAPI before making a call.
  • Resolve the canonical asset or collection identifier, issuer, network, lifecycle, supply, and required proof freshness.

WHAT TO DO NEXT

  • Keep this operation disabled in clients, agents, SDKs, and workflow automation while it remains planned-contract.
  • Use the stated owner, lifecycle, authority boundary, and provisional token inventory profile to prepare requirements and conformance tests without sending a request.
  • Monitor the capability registry for implemented-contract, then re-fetch deployed OpenAPI and validate its exact security, parameters, schemas, responses, and agent metadata before enabling the integration.

AGENT GUIDANCE

  • Never call this planned contract, include it in an executable tool registry, or infer runtime availability from this readable page.
  • Its capability-registry profile is provisional integration guidance, not an executable request schema.
  • Use token inventory only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
  • Treat the proposed token_uuid (query) as planning input only; re-generate the request from deployed OpenAPI before making a call.
  • Distinguish declared metadata, issuer identity, collection membership, mint evidence, supply state, ownership or custody, market listing, price, transfer, and finality.
  • Use response links and canonical identifiers instead of constructing internal service URLs or scraping the website.
  • When implementation lands, discard generated requests based on this planning record and rebuild them from the deployed OpenAPI operation.
MACHINE CONTRACT

This operation is a non-executable planning contract. Its capability-registry record defines the intended owner, parameters, responses, and integration boundary until an implemented Rust OpenAPI operation replaces it.

EXTENDED INTEGRATION GUIDANCE

Readable request and response reference

Examples describe the reviewed planning contract and remain non-executable until promoted into OpenAPI.

PARAMETERS

Headers, path, query, and body

NAMELOCATIONPRESENCETYPE / RULES / PURPOSE
AuthorizationheaderRequired

Bearer tokenCredential containing assets:read authority.EXAMPLEBearer hc_live_…

token_uuidqueryRequired

legacy token identifierLegacy security-token identifier. Do not call this planning route; use the canonical replacement described in agent guidance.EXAMPLE11111111111111111111111111111111

RESPONSES

Status and payload examples

200Canonical resource projection.Not executable · JSON RESPONSE+
{
  "result": "See the operation's authoritative OpenAPI response schema."
}
INTEGRATION DECISION
CALLER ACTION
Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY
Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION
No runtime state exists to reconcile for this planning contract. Continue from market-scoped catalog, order, trade, position, collateral, and settlement projections while Python remains authoritative through an implemented operation.
ESCALATE WHEN
Escalate any ambiguous order or settlement outcome while preserving suspension and Python authority; never enable ingress, publishing, allowlists, markets, or traffic as recovery.
401Bearer credential is missing, expired, or invalid.Not executable · JSON RESPONSE+
{
  "code": "request_failed",
  "message": "Bearer credential is missing, expired, or invalid."
}
INTEGRATION DECISIONrequest_failed
CALLER ACTION
Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY
Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION
No runtime state exists to reconcile for this planning contract. Continue from market-scoped catalog, order, trade, position, collateral, and settlement projections while Python remains authoritative through an implemented operation.
ESCALATE WHEN
Escalate any ambiguous order or settlement outcome while preserving suspension and Python authority; never enable ingress, publishing, allowlists, markets, or traffic as recovery.
403The principal lacks the required scope, role, tenant, or step-up authority.Not executable · JSON RESPONSE+
{
  "code": "request_failed",
  "message": "The principal lacks the required scope, role, tenant, or step-up authority."
}
INTEGRATION DECISIONrequest_failed
CALLER ACTION
Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY
Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION
No runtime state exists to reconcile for this planning contract. Continue from market-scoped catalog, order, trade, position, collateral, and settlement projections while Python remains authoritative through an implemented operation.
ESCALATE WHEN
Escalate any ambiguous order or settlement outcome while preserving suspension and Python authority; never enable ingress, publishing, allowlists, markets, or traffic as recovery.
422Path, query, or body validation failed.Not executable · JSON RESPONSE+
{
  "code": "request_failed",
  "message": "Path, query, or body validation failed."
}
INTEGRATION DECISIONrequest_failed
CALLER ACTION
Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY
Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION
No runtime state exists to reconcile for this planning contract. Continue from market-scoped catalog, order, trade, position, collateral, and settlement projections while Python remains authoritative through an implemented operation.
ESCALATE WHEN
Escalate any ambiguous order or settlement outcome while preserving suspension and Python authority; never enable ingress, publishing, allowlists, markets, or traffic as recovery.
503The authoritative service or read model is unavailable.Not executable · JSON RESPONSE+
{
  "code": "request_failed",
  "message": "The authoritative service or read model is unavailable."
}
INTEGRATION DECISIONrequest_failed
CALLER ACTION
Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY
Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION
No runtime state exists to reconcile for this planning contract. Continue from market-scoped catalog, order, trade, position, collateral, and settlement projections while Python remains authoritative through an implemented operation.
ESCALATE WHEN
Escalate any ambiguous order or settlement outcome while preserving suspension and Python authority; never enable ingress, publishing, allowlists, markets, or traffic as recovery.

OPERATIONAL NOTES

Security and lifecycle guarantees

  • The Rust gateway validates the public contract and routes only to the authoritative owner; clients never address internal services directly.

UPGRADING FROM V1

Legacy calls replaced by this operation

If you maintain an older integration, use this map to find the V2 replacement. Do not translate the old request field-for-field: rebuild it from the V2 parameters and schemas above because identity, authorization, replay protection, and response semantics may have changed.

GET/api/v1/tokens/inventoryTOKENS: Get Token Inventory
DOCUMENTATION STATUS

This planned contract now defines its public parameters, authorization boundary, replay behavior, responses, and authoritative owner. It remains non-executable until its owner adapter and conformance tests are promoted into the Rust gateway.

Return to the V2 directory ↗