GET

MPC wallet lifecycle

Get portfolio

/api/v2/wallets/portfolio
AUTHENTICATIONBearer token · wallets:readService ownercustody-serviceContract sourceOpenAPISTATUSProduction listed

Purpose and usage

What this endpoint does

Return the authenticated workspace's MPC custody portfolio, chain-capability posture, token-import networks, reviewed token catalog, enabled assets, and recent activity without granting any wallet authority.

When to use it

Call this when a wallet, treasury, custody, or governed agent workflow needs to discover portfolio 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 portfolio.
  • 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.
  • Use the live OpenAPI schema as the authority for the exact request shape and response model.
  • 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 portfolio only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
  • Use the live OpenAPI schema as the authority for the exact request shape and response model.
  • 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 wallets:read authority.EXAMPLEBearer hc_live_…

X-Request-IDheaderOptional

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

RESPONSES

Status and payload examples

200Workspace-scoped MPC wallet portfolio, chain capability posture, supported token-import networks, reviewed token catalog, enabled assets, and recent activity. Catalog visibility grants no enrollment, signing, broadcast, trading, or value authority.Read completed · JSON RESPONSE+
"example-value"
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. Re-read the wallet, intent, reservation, and transaction status on the same network; compare policy version, nonce, digest, and terminal receipt before another command.
401Bearer credential is missing, expired, or invalid.Authentication required · JSON RESPONSE+
{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid credential is invalid"
}
INTEGRATION DECISIONinvalid_credentials
CALLER ACTION
Discard the rejected credential, complete the documented authentication or reassertion flow, and rebuild any request signature with fresh timestamps and nonces.
RETRY SAFETY
Retry only with a newly valid credential and fresh replay-protection values. Do not replay an expired signature.
STATE RECONCILIATION
Authentication failed before an authoritative read was returned for owner-scoped wallet inventory, custody policy, balances, intents, reservations, transactions, and receipts.
ESCALATE WHEN
Escalate when funds, reservations, transaction digests, or MPC state remain ambiguous after authoritative wallet and network reconciliation.
403The principal lacks the required scope, role, tenant, or step-up authority.Authority or policy denied · JSON RESPONSE+
{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid credential is invalid"
}
INTEGRATION DECISIONinvalid_credentials
CALLER ACTION
Verify the exact scope, tenant or workspace membership, owner boundary, step-up purpose, feature policy, and resource eligibility. Never broaden authority automatically.
RETRY SAFETY
Do not retry until the missing authority or policy condition has been deliberately resolved with least privilege.
STATE RECONCILIATION
Confirm the caller and resource resolve to the same authority boundary for owner-scoped wallet inventory, custody policy, balances, intents, reservations, transactions, and receipts.
ESCALATE WHEN
Escalate when funds, reservations, transaction digests, or MPC state remain ambiguous after authoritative wallet and network reconciliation.
503The authoritative service or read model is unavailable.Dependency unavailable or outcome uncertain · JSON RESPONSE+
{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid credential is invalid"
}
INTEGRATION DECISIONinvalid_credentials
CALLER ACTION
Treat the failure as transient and preserve the last known good representation without presenting it as fresh.
RETRY SAFETY
Retry with bounded exponential backoff and jitter; stop after the integration's failure budget is exhausted.
STATE RECONCILIATION
Re-read the wallet, intent, reservation, and transaction status on the same network; compare policy version, nonce, digest, and terminal receipt before another command.
ESCALATE WHEN
Escalate when funds, reservations, transaction digests, or MPC state remain ambiguous after authoritative wallet and network reconciliation.

OPERATIONAL NOTES

Security and lifecycle guarantees

  • Return the authenticated workspace's MPC custody portfolio, chain-capability posture, token-import networks, reviewed token catalog, enabled assets, and recent activity without granting any wallet authority. Authoritative owner: custody-service.
  • The Rust gateway validates the public contract and routes only to the authoritative owner; clients never address internal services directly.
  • The tables and examples are derived from the current gateway source OpenAPI. Re-fetch the deployed OpenAPI before execution; deployment status is shown separately on this page.
  • Only parameters present in the OpenAPI operation are accepted; undocumented query keys fail closed with HTTP 422.
Reference version and availability details

This route is implemented in canonical gateway source and appears in the production OpenAPI snapshot observed 2026-10-02T23:27:55.510Z. Authentication, tenant, feature, venue, and market policy still apply.

Verify the exact production OpenAPI operation Return to the V2 directory