GET

User Profile Data

Get wallet balances

/api/v2/ledger/accounts/{account_id}/balances

AUTHENTICATIONBearer token · ledger:readService ownercustody-ledgerContract sourceOpenAPISTATUSProduction listed

Purpose and usage

What this endpoint does

List wallet balances through the authoritative custody service boundary.

When to use it

Call this when a wallet, treasury, custody, or governed agent workflow needs to discover wallet balances and choose a canonical record for a later step so it can make a custody decision inside the correct owner, workspace, network, and policy boundary.

OUTCOME · Discover

What changes

Read-only projection; it grants no mutation, settlement, traffic, or authority change.

WHY IT MATTERS

Gives people and agents a contract-backed way to discover wallet balances.
Makes custody state understandable without exposing seeds, shares, nonces, private keys, or other reusable signing material.

ISOLATION + AUTHORITY

The authenticated owner, workspace, network, and wallet policy remain authoritative. A wallet record, policy result, approval, ceremony, or balance never grants another lifecycle stage and cannot substitute for threshold signing or separately owned funding, settlement, publisher, matching, or trading authority.

BEFORE YOU CALL

Authenticate at the documented boundary: bearer+scope.
Supply the required account_id (path) exactly as defined by the live contract.
Resolve the active workspace, network, wallet lifecycle, and applicable custody policy before relying on this result.

WHAT TO DO NEXT

Select one canonical identifier from the response and open its detail operation when the live contract exposes one.
Re-read the wallet and policy state before the next governed action, especially after an ambiguous or concurrent result.

AGENT GUIDANCE

Use wallet balances only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Supply the required account_id (path) exactly as defined by the live contract.
Keep enrollment, activation, policy evaluation, approval, ceremony, signing, submission, confirmation, and settlement as distinct states.
Use response links and canonical identifiers instead of constructing internal service URLs or scraping the website.

Contract reference

Use the deployed OpenAPI for exact parameters, schemas and security requirements. The tables below provide integration guidance.

Open this operation in OpenAPI

Request and response

Make the request

Examples illustrate integration intent; the referenced OpenAPI operation and component schemas define the executable shape.

PARAMETERS

Headers, path, query, and body

NAMELOCATIONPRESENCETYPE / RULES / PURPOSE

AuthorizationheaderRequired

Bearer tokenCredential containing ledger:read authority.EXAMPLEBearer hc_live_…

account_idpathRequired

identifierAuthenticated profile ledger account identifier. It selects the exact account id addressed by this route.EXAMPLEaccount-id-01

X-Request-IDheaderOptional

stringOptional caller correlation identifier. The gateway emits the effective value on the response.

RESPONSES

Status and payload examples

200Authoritative custody-ledger balancesRead completed · JSON RESPONSE+

{
  "account_id": "01K4A7M4N8Y2Q6R9T3V5W7X1ZB",
  "account_type": "example-account-type",
  "balance_authority": "100.00",
  "items": [
    {
      "asset": "example-asset",
      "asset_class": "example-asset-class",
      "available": "example-available",
      "name": "example-name",
      "pending": "example-pending",
      "total": "example-total",
      "updated_at": "2026-09-02T18:30:00Z"
    }
  ],
  "valuation_included": true,
  "vault_id": "01K4A7M4N8Y2Q6R9T3V5W7X1ZB"
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then select one canonical identifier from the response and open its detail operation when the live contract exposes one.
RETRY SAFETY: Repeat only when the integration needs a fresher authoritative projection.
STATE RECONCILIATION: Use returned identifiers and versions as the comparison point for later reads. Refresh the specific profile or account projection and compare tenant, profile, lifecycle, and version identifiers before retrying.

401Bearer credential is missing, expired, or invalid.Authentication required · JSON RESPONSE+

{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid credential is invalid"
}