DOCUMENTATIONv2

DELETE

MPC wallet lifecycle

Revoke approved address

/api/v2/wallets/{wallet_uuid}/approved-addresses/{address_uuid}

AUTHENTICATIONBearer token · wallets:writeAUTHORITATIVE OWNERcustody-serviceCONTRACT 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: revoke an approved destination while preserving audit evidence.

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 approved address workflow; enable it only after the status becomes implemented-contract and the exact operation appears in deployed OpenAPI.

OUTCOME · Planned · Revoke or retire

What changes

None today: this route is not executable. Its intended behavior is: no executable public mutation exists. A future success would block new use and retain REVOKED history; it would not erase the destination, cancel or reverse a submitted transfer, change balances, revoke a wallet, or remove prior evidence.

WHY IT MATTERS

Lets people and agents prepare for approved address without falsely presenting roadmap scope as a live capability.
Gives people and agents a contract-backed way to advance approved address.
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. 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+scope.
Treat the proposed wallet_uuid (path), address_uuid (path), expected_wallet_version (body), expected_address_version (body), reason_code (body), step_up_token (body) as planning input only; re-generate the request from deployed OpenAPI before making a call.
Use one Idempotency-Key only for retries of the same byte-equivalent logical mutation.
Resolve the active workspace, network, wallet lifecycle, and applicable custody policy before relying on this result.

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 approved address 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 approved address only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Treat the proposed wallet_uuid (path), address_uuid (path), expected_wallet_version (body), expected_address_version (body), reason_code (body), step_up_token (body) as planning input only; re-generate the request from deployed OpenAPI before making a call.
Keep enrollment, activation, policy evaluation, approval, ceremony, signing, submission, confirmation, and settlement as distinct states.
After a timeout or conflict, read authoritative state before deciding whether an equivalent retry is safe.
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 the wallets:write scope.EXAMPLEBearer hc_live_…

Idempotency-KeyheaderRequired

ASCII string · 1–128Caller-generated key reused for every retry of the same logical mutation.EXAMPLElaunch-treasury-v1-001

Content-TypeheaderRequired

application/jsonSigned mutations accept canonical JSON only.EXAMPLEapplication/json

Content-DigestheaderRequired

RFC 9530 SHA-256 digestDigest of the exact transmitted body bytes.EXAMPLEsha-256=:47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=:

Signature-InputheaderRequired

RFC 9421 signature parametersCovers @method, @path, content-digest, content-type, and idempotency-key; includes keyid, nonce, created, and expires.EXAMPLEsig1=("@method" "@path" "content-digest" "content-type" "idempotency-key");created=1786582800;expires=1786583100;nonce="01J…";keyid="machine-prod"

SignatureheaderRequired

Ed25519 HTTP Message SignatureSignature made by an active public key registered to the authenticated client.EXAMPLEsig1=:base64-signature:

wallet_uuidpathRequired

workspace wallet identifierWallet owning the approval.EXAMPLEwallet-01

address_uuidpathRequired

approved-destination identifierExact destination approval to revoke.EXAMPLEapproved-address-01

expected_wallet_versionbodyRequired

integer · ≥1Current wallet policy version.EXAMPLE5

expected_address_versionbodyRequired

integer · ≥1Current approval version.EXAMPLE2

reason_codebodyRequired

OWNER_REVOKED | COMPROMISE_SUSPECTED | DESTINATION_RETIRED | COMPLIANCE_HOLDReason selecting incident, screening, delay, notification, and evidence policy.EXAMPLEDESTINATION_RETIRED

reason_detailbodyOptional

string · 8–500Safe explanation without credentials, customer data, or signing material.EXAMPLEDestination is no longer operated.

step_up_tokenbodyRequired

purpose-bound tokenFresh APPROVED_ADDRESS_REVOCATION authorization.EXAMPLEhcsu_…

REQUEST

JSON body example

{
  "expected_wallet_version": 5,
  "expected_address_version": 2,
  "reason_code": "DESTINATION_RETIRED",
  "reason_detail": "Destination is no longer operated.",
  "step_up_token": "hcsu_…"
}

RESPONSES

Status and payload examples

200Destination marked REVOKED and blocked for future use; historical approvals and transfers remain retained.Not executable · JSON RESPONSE+

{
  "wallet_uuid": "wallet-01",
  "address_uuid": "approved-address-01",
  "status": "REVOKED",
  "version": 3,
  "future_use_blocked": true,
  "historical_transfers_retained": true,
  "revocation_commitment": "eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee"
}

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 owner-scoped wallet inventory, custody policy, balances, intents, reservations, transactions, and receipts through an implemented operation.
ESCALATE WHEN: Escalate when funds, reservations, transaction digests, or MPC state remain ambiguous after authoritative wallet and network reconciliation.

400Versions, reason, signature, step-up, or Idempotency-Key is malformed.Not executable · JSON RESPONSE+

{
  "code": "invalid_address_revocation",
  "message": "Versions, reason, signature, step-up, or Idempotency-Key is malformed."
}

INTEGRATION DECISIONinvalid_address_revocation

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 owner-scoped wallet inventory, custody policy, balances, intents, reservations, transactions, and receipts through an implemented operation.
ESCALATE WHEN: Escalate when funds, reservations, transaction digests, or MPC state remain ambiguous after authoritative wallet and network reconciliation.

401The bearer credential is invalid.Not executable · JSON RESPONSE+

{
  "code": "invalid_credentials",
  "message": "The bearer credential is invalid."
}

INTEGRATION DECISIONinvalid_credentials

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 owner-scoped wallet inventory, custody policy, balances, intents, reservations, transactions, and receipts through an implemented operation.
ESCALATE WHEN: Escalate when funds, reservations, transaction digests, or MPC state remain ambiguous after authoritative wallet and network reconciliation.

403The principal lacks wallets:write, destination authority, reason-specific authority, or fresh step-up.Not executable · JSON RESPONSE+

{
  "code": "address_revocation_forbidden",
  "message": "The principal lacks wallets:write, destination authority, reason-specific authority, or fresh step-up."
}

INTEGRATION DECISIONaddress_revocation_forbidden

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 owner-scoped wallet inventory, custody policy, balances, intents, reservations, transactions, and receipts through an implemented operation.
ESCALATE WHEN: Escalate when funds, reservations, transaction digests, or MPC state remain ambiguous after authoritative wallet and network reconciliation.

404The wallet or destination approval is not owner-visible.Not executable · JSON RESPONSE+

{
  "code": "approved_address_not_found",
  "message": "The wallet or destination approval is not owner-visible."
}

INTEGRATION DECISIONapproved_address_not_found

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 owner-scoped wallet inventory, custody policy, balances, intents, reservations, transactions, and receipts through an implemented operation.
ESCALATE WHEN: Escalate when funds, reservations, transaction digests, or MPC state remain ambiguous after authoritative wallet and network reconciliation.

409A version is stale, revocation is terminal, or an in-flight transfer crossed its protection boundary.Not executable · JSON RESPONSE+

{
  "code": "address_revocation_conflict",
  "message": "A version is stale, revocation is terminal, or an in-flight transfer crossed its protection boundary."
}

INTEGRATION DECISIONaddress_revocation_conflict

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 owner-scoped wallet inventory, custody policy, balances, intents, reservations, transactions, and receipts through an implemented operation.
ESCALATE WHEN: Escalate when funds, reservations, transaction digests, or MPC state remain ambiguous after authoritative wallet and network reconciliation.

422Reason, screening, incident, delay, transfer, retention, or lifecycle policy rejected revocation.Not executable · JSON RESPONSE+

{
  "code": "address_revocation_rejected",
  "message": "Reason, screening, incident, delay, transfer, retention, or lifecycle policy rejected revocation."
}

INTEGRATION DECISIONaddress_revocation_rejected

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 owner-scoped wallet inventory, custody policy, balances, intents, reservations, transactions, and receipts through an implemented operation.
ESCALATE WHEN: Escalate when funds, reservations, transaction digests, or MPC state remain ambiguous after authoritative wallet and network reconciliation.

503Custody, transfer, screening, incident, or evidence ownership is unavailable.Not executable · JSON RESPONSE+

{
  "code": "address_revocation_unavailable",
  "message": "Custody, transfer, screening, incident, or evidence ownership is unavailable."
}

INTEGRATION DECISIONaddress_revocation_unavailable

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 owner-scoped wallet inventory, custody policy, balances, intents, reservations, transactions, and receipts through an implemented operation.
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

Reviewed planning contract: do not call until present in live production OpenAPI.
Revocation is not deletion. It cannot cancel or reverse a submitted transfer, change balances, revoke the wallet, or erase prior approval and transfer evidence.
COMPROMISE_SUSPECTED and COMPLIANCE_HOLD require separately configured incident or compliance authority.
After ambiguity, re-read the address approval and affected transfer intents before retrying the same Idempotency-Key and body.

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 ↗