DOCUMENTATIONv2

GET

AI wallet control

Get intent

/api/v2/ai-wallets/{binding_id}/intents/{intent_id}

AUTHENTICATIONBearer token · ai-wallets:readAUTHORITATIVE OWNERcore-ai-wallet-controlCONTRACT AUTHORITYGenerated Rust OpenAPISTATUSSource ready · production listed

PURPOSE + BUSINESS CONTEXT

Return one exact retained intent, decision, reason-code set, and policy version.

WHEN THIS CALL IS USEFUL

Call this when a wallet, treasury, custody, or governed agent workflow needs to inspect one specific intent before presenting it or making a dependent decision so it can make a custody decision inside the correct owner, workspace, network, and policy boundary.

OUTCOME · Inspect

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 inspect intent.
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 binding_id (path), intent_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

Re-read the wallet and policy state before the next governed action, especially after an ambiguous or concurrent result.
Refresh intent when its observation time, version, or lifecycle state is no longer adequate for the decision.

AGENT GUIDANCE

Use intent only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Supply the required binding_id (path), intent_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.

AI WALLET AUTHORITY BOUNDARY

Implemented reads expose bearer-derived workspace projections, exact policy versions and commitments, independent native-asset budgets, retained decisions, and execution-readiness evidence. POLICY_APPROVED is not transaction construction, signing, broadcast, confirmation, or settlement. The implemented intent-evaluation route is a dry run: it creates no intent, reservation, event, approval, transaction, signature, or broadcast. Any lifecycle, policy, retained-intent, cancellation, or execution operation marked planned is non-executable and must not be registered as an agent tool.

MACHINE CONTRACT

The exact deployed parameters, schemas, responses, security requirements, and Hybrid-Chain agent metadata are authoritative at this operation's production OpenAPI JSON Pointer. The readable tables below add integration guidance; the deployed OpenAPI controls if guidance and the machine contract ever differ.

Open the authoritative production contract ↗

EXTENDED INTEGRATION GUIDANCE

Readable request and response reference

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 the ai-wallets:read scope.EXAMPLEBearer hc_live_…

binding_idpathRequired

32-character lowercase hexadecimal UUIDAI wallet binding visible in the authenticated workspace.EXAMPLEa1b2c3d4e5f6471890abcdeffedcba09

intent_idpathRequired

32-character lowercase hexadecimal UUIDRetained intent under this exact binding.EXAMPLEf9e8d7c6b5a4432190abcdeffedcba01

X-Request-IDheaderOptional

stringOptional caller correlation value. The gateway returns the effective request identifier.EXAMPLEagent-run-20260901-0042

RESPONSES

Status and payload examples

200One retained intent and policy decision.Read completed · JSON RESPONSE+

{
  "intent_uuid": "f9e8d7c6b5a4432190abcdeffedcba01",
  "binding_uuid": "a1b2c3d4e5f6471890abcdeffedcba09",
  "workspace_uuid": "workspace-01",
  "policy_uuid": "104db2e6b7b842bb8ab733e3b6e74870",
  "policy_version": 4,
  "workload_client_id": "hcwc_agent01",
  "idempotency_key": "historical-intent-key",
  "intent_type": "TRANSFER",
  "capability": "wallet:quote",
  "asset_code": "DHYBRID",
  "amount": "25.00000000",
  "destination_type": "ADDRESS",
  "destination_reference": "dhyb1approveddestination…",
  "purpose": "Preview treasury allocation",
  "rationale": null,
  "rationale_commitment": null,
  "state": "POLICY_APPROVED",
  "decision_code": "POLICY_ALLOWED",
  "intent_commitment": "d883902c…",
  "reservation_commitment": null,
  "requested_by_profile_uuid": null,
  "created": "2026-09-01T18:10:00Z",
  "updated": "2026-09-01T18:10:00Z",
  "expires_at": null,
  "settled_at": null
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then re-read the wallet and policy state before the next governed action, especially after an ambiguous or concurrent result.
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.

401The bearer credential is missing or invalid.Authentication required · JSON RESPONSE+

{
  "code": "invalid_credentials",
  "message": "The bearer credential is missing or 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 credential lacks ai-wallets:read or is outside the derived workspace.Authority or policy denied · JSON RESPONSE+

{
  "code": "insufficient_scope",
  "message": "The credential lacks ai-wallets:read or is outside the derived workspace."
}

INTEGRATION DECISIONinsufficient_scope

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.

404The binding or child resource is not visible in this workspace.Resource not visible · JSON RESPONSE+

{
  "code": "ai_wallet_resource_not_found",
  "message": "The binding or child resource is not visible in this workspace."
}

INTEGRATION DECISIONai_wallet_resource_not_found

CALLER ACTION: Verify the canonical identifier and authenticated owner boundary. A 404 may intentionally conceal a resource outside the caller's authority.
RETRY SAFETY: Do not retry the unchanged identifier repeatedly. Refresh the relevant collection or lookup before choosing another identifier.
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.

422One or more path identifiers are malformed.Request must change · JSON RESPONSE+

{
  "code": "invalid_identifier",
  "message": "One or more path identifiers are malformed."
}

INTEGRATION DECISIONinvalid_identifier

CALLER ACTION: Rebuild the request from the live OpenAPI operation and correct the rejected method, media type, header, parameter, or body field.
RETRY SAFETY: Do not retry the same invalid request. A corrected read may be sent as a new attempt.
STATE RECONCILIATION: Compare the submitted values with the documented constraints before another call. 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.

503The authoritative AI wallet control plane is unavailable and failed closed.Dependency unavailable or outcome uncertain · JSON RESPONSE+

{
  "code": "ai_wallet_control_unavailable",
  "message": "The authoritative AI wallet control plane is unavailable and failed closed."
}

INTEGRATION DECISIONai_wallet_control_unavailable

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

The gateway derives workspace and principal context from the bearer; callers cannot supply or override either boundary.
Policy approval is evidence of a policy decision only. It is never transaction construction, signing, broadcast, confirmation, settlement, or value-movement authority.
Amounts and limits are exact native-asset decimal strings. Never parse them through binary floating point or aggregate unlike assets.
Private keys, MPC shares, seeds, signing nonces, participant secrets, and credentials are never accepted or returned.
POLICY_APPROVED does not imply a reservation, transaction, signature, broadcast, or settlement.

DOCUMENTATION STATUS

This route is implemented in canonical gateway source and appears in the production OpenAPI snapshot observed 2026-09-11T06:35:11.572Z. Authentication, tenant, feature, venue, and market policy still apply.

Verify the exact production OpenAPI operation ↗Return to the V2 directory ↗