DOCUMENTATIONv2

POST

Digital assets

Burn asset

/api/v2/assets/{asset_uuid}/burns

AUTHENTICATIONBearer token · assets:supplyAUTHORITATIVE OWNERasset-registry-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: create a governed burn operation against eligible holdings.

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

OUTCOME · Planned · Create or advance

What changes

None today: this route is not executable. Its intended behavior is: no executable public mutation exists. A future success would atomically debit the exact holding, reduce total supply, and append reason-bound evidence; it could not create negative balances, reverse another transfer, or erase historical ownership.

WHY IT MATTERS

Lets people and agents prepare for burn asset without falsely presenting roadmap scope as a live capability.
Gives people and agents a contract-backed way to advance burn asset.
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+scope.
Treat the proposed asset_uuid (path), holding_reference (body), quantity (body), expected_asset_version (body), expected_holding_balance (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 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 burn asset 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 burn asset only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Treat the proposed asset_uuid (path), holding_reference (body), quantity (body), expected_asset_version (body), expected_holding_balance (body), reason_code (body), step_up_token (body) 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.
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 assets:supply 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:

asset_uuidpathRequired

asset identifierAsset whose eligible circulating supply is retired.EXAMPLEasset-01

holding_referencebodyRequired

owner-safe holding identifierOpaque eligible holding resolved by the authoritative owner.EXAMPLEholding-01

quantitybodyRequired

positive exact decimal stringQuantity to retire without floating-point conversion.EXAMPLE5.00000000

expected_asset_versionbodyRequired

integer · ≥1Current asset version for optimistic concurrency.EXAMPLE8

expected_holding_balancebodyRequired

non-negative exact decimal stringLast-read available holding balance; a stale value fails closed.EXAMPLE25.00000000

reason_codebodyRequired

RETIRE | REDEEM | CORRECT_ISSUANCE | GOVERNANCEReason selecting holder, issuer, governance, evidence, compliance, and accounting policy.EXAMPLEREDEEM

evidence_commitmentbodyOptional

64-character hexadecimal SHA-256 digestCommitment to separately retained reason evidence; raw evidence and credentials are forbidden.EXAMPLEeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee

step_up_tokenbodyRequired

purpose-bound tokenFresh ASSET_BURN authorization bound to holding, quantity, balance, version, and reason.EXAMPLEhcsu_…

REQUEST

JSON body example

{
  "holding_reference": "holding-01",
  "quantity": "5.00000000",
  "expected_asset_version": 8,
  "expected_holding_balance": "25.00000000",
  "reason_code": "REDEEM",
  "evidence_commitment": "eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
  "step_up_token": "hcsu_…"
}

RESPONSES

Status and payload examples

200Eligible holding and total supply atomically reduced with reason-bound evidence.Not executable · JSON RESPONSE+

{
  "burn_uuid": "burn-01",
  "asset_uuid": "asset-01",
  "holding_reference": "holding-01",
  "quantity": "5.00000000",
  "total_supply": "1020.00000000",
  "holding_balance": "20.00000000",
  "reason_code": "REDEEM",
  "burn_commitment": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"
}

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.

400A field, signed header, step-up token, or idempotency key is malformed.Not executable · JSON RESPONSE+

{
  "code": "invalid_asset_burn",
  "message": "A field, signed header, step-up token, or idempotency key is malformed."
}

INTEGRATION DECISIONinvalid_asset_burn

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.

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 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 assets:supply, reason-specific holding authority, or fresh step-up.Not executable · JSON RESPONSE+

{
  "code": "asset_burn_forbidden",
  "message": "The principal lacks assets:supply, reason-specific holding authority, or fresh step-up."
}

INTEGRATION DECISIONasset_burn_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 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.

404The asset, holding, authority, or referenced evidence was not found.Not executable · JSON RESPONSE+

{
  "code": "asset_burn_resource_not_found",
  "message": "The asset, holding, authority, or referenced evidence was not found."
}

INTEGRATION DECISIONasset_burn_resource_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 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.

409Version or balance is stale, quantity is unavailable, lifecycle or reason is ineligible, or idempotency conflicts.Not executable · JSON RESPONSE+

{
  "code": "asset_burn_conflict",
  "message": "Version or balance is stale, quantity is unavailable, lifecycle or reason is ineligible, or idempotency conflicts."
}

INTEGRATION DECISIONasset_burn_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 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.

422Precision, supply floor, balance, evidence, compliance, authority, or accounting policy rejected burning.Not executable · JSON RESPONSE+

{
  "code": "asset_burn_rejected",
  "message": "Precision, supply floor, balance, evidence, compliance, authority, or accounting policy rejected burning."
}

INTEGRATION DECISIONasset_burn_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 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.

503Registry, holdings, accounting, evidence, or atomic ownership is unavailable; supply and holdings are unchanged.Not executable · JSON RESPONSE+

{
  "code": "asset_burn_unavailable",
  "message": "Registry, holdings, accounting, evidence, or atomic ownership is unavailable; supply and holdings are unchanged."
}

INTEGRATION DECISIONasset_burn_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 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

Reviewed planning contract: do not call until the exact operation appears in live production OpenAPI.
Read the asset and holding immediately before submission. On 409, form a new intent from fresh version and balance rather than burning stale state.
Each reason code has separate consent, authority, evidence, compliance, legal-hold, notification, and accounting requirements.
A burn cannot create a negative balance, erase ownership history, reverse another transfer, or accept raw identity evidence, receipts, credentials, private keys, seeds, or MPC material.

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 ↗