DOCUMENTATIONv2

POST

Transfer compliance

Authorize disclosure envelope

/api/v2/transfer-compliance/disclosure-envelopes

AUTHENTICATIONBearer token · compliance:writeAUTHORITATIVE OWNERtransfer-compliance-serviceCONTRACT AUTHORITYGenerated Rust OpenAPISTATUSSource ready · production listed

PURPOSE + BUSINESS CONTEXT

Encrypt and queue an authorized disclosure envelope for an approved counterparty key.

WHEN THIS CALL IS USEFUL

Use only after client-side encryption of a canonical payload for the currently approved counterparty key and after a matching consent-bound manifest exists.

OUTCOME · Create or advance

What changes

When promoted, Identity authorizes a recipient-, manifest-, ciphertext-digest-, schema-, payload-, algorithm-, key-, associated-data-, and expiry-bound envelope commitment. Identity never receives ciphertext; Core delivery remains a separate unpublished operation.

WHY IT MATTERS

Gives people and agents a contract-backed way to advance authorize disclosure envelope.
Supports policy-compliant transfer coordination while minimizing personal data and separating compliance evidence from value movement.

ISOLATION + AUTHORITY

Owner, workspace, counterparty, VASP, credential issuer, wallet controller, transfer, reviewer, disclosure recipient, purpose, and retention boundaries remain distinct. A credential, preparation, decision, manifest, envelope, disclosure, or Explorer record neither moves value nor substitutes for wallet authorization, sanctions policy, rail admission, settlement, or finality.

BEFORE YOU CALL

Authenticate at the documented boundary: bearer+scope.
Supply the required manifest_uuid (body), manifest_commitment (body), ciphertext_sha256 (body), payload_commitment (body), recipient_key_id (body), associated_data_commitment (body) exactly as defined by the live contract.
Use one Idempotency-Key only for retries of the same byte-equivalent logical mutation.
Resolve the transfer parties, network, policy jurisdiction, required credential and proof classes, disclosure purpose, recipient, and retention basis.

WHAT TO DO NEXT

Re-read authorize disclosure envelope using the canonical identifier returned by this operation.
Reconcile an ambiguous response with the same idempotency key before attempting another mutation.
Re-read the transfer and credential state, verify purpose and recipient binding, and disclose only the fields required by the current policy stage.

AGENT GUIDANCE

Use authorize disclosure envelope only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Supply the required manifest_uuid (body), manifest_commitment (body), ciphertext_sha256 (body), payload_commitment (body), recipient_key_id (body), associated_data_commitment (body) exactly as defined by the live contract.
Keep counterparty registration, credential validity, wallet-control proof, transfer intent, data preparation, review decision, disclosure authorization, delivery, value movement, and settlement as separate facts.
After a timeout or conflict, read authoritative state before deciding whether an equivalent retry is safe.

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 compliance: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:

manifest_uuidbodyRequired

32-character identifierCurrent subject-owned consent manifest.EXAMPLEeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee

manifest_commitmentbodyRequired

64-character SHA-256 digestCommitment that must match the selected current manifest.EXAMPLE1111111111111111111111111111111111111111111111111111111111111111

ciphertext_sha256bodyRequired

64-character SHA-256 digestDigest of client-side ciphertext. Identity never receives the ciphertext.EXAMPLE8888888888888888888888888888888888888888888888888888888888888888

payload_schemabodyOptional

identifier · max 64Canonical cleartext schema; defaults to IVMS101_2023.EXAMPLEIVMS101_2023

payload_commitmentbodyRequired

64-character SHA-256 digestCommitment to the canonical cleartext payload before encryption.EXAMPLE9999999999999999999999999999999999999999999999999999999999999999

encryption_algorithmbodyOptional

identifier · max 64Client-side envelope algorithm; defaults to X25519-XCHACHA20-POLY1305.EXAMPLEX25519-XCHACHA20-POLY1305

recipient_key_idbodyRequired

string · max 96Approved recipient public encryption-key identifier.EXAMPLEexample-encryption-2026-09

associated_data_commitmentbodyRequired

64-character SHA-256 digestCommitment to recipient, purpose, schema, and protocol associated data.EXAMPLEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa

REQUEST

JSON body example

{
  "manifest_uuid": "eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
  "manifest_commitment": "1111111111111111111111111111111111111111111111111111111111111111",
  "ciphertext_sha256": "8888888888888888888888888888888888888888888888888888888888888888",
  "payload_schema": "IVMS101_2023",
  "payload_commitment": "9999999999999999999999999999999999999999999999999999999999999999",
  "encryption_algorithm": "X25519-XCHACHA20-POLY1305",
  "recipient_key_id": "example-encryption-2026-09",
  "associated_data_commitment": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

RESPONSES

Status and payload examples

201Short-lived manifest- and recipient-bound envelope authorization.Mutation completed · JSON RESPONSE+

{
  "authorization_id": "00000000000000000000000000000000",
  "manifest_id": "eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
  "manifest_commitment": "1111111111111111111111111111111111111111111111111111111111111111",
  "counterparty_did": "did:hybrid:vasp:example",
  "ciphertext_sha256": "8888888888888888888888888888888888888888888888888888888888888888",
  "payload_schema": "IVMS101_2023",
  "payload_commitment": "9999999999999999999999999999999999999999999999999999999999999999",
  "encryption_algorithm": "X25519-XCHACHA20-POLY1305",
  "recipient_key_id": "example-encryption-2026-09",
  "associated_data_commitment": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "authorization_commitment": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
  "status": "VALID",
  "valid_until": "2026-09-02T18:00:00Z",
  "revoked_at": null,
  "created_at": "2026-09-01T18:05:00Z",
  "updated_at": "2026-09-01T18:05:00Z"
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then re-read authorize disclosure envelope using the canonical identifier returned by this operation.
RETRY SAFETY: Do not repeat a successful mutation merely to confirm it. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION: Persist returned identifiers, versions, commitments, and receipts. Refresh the policy version, subject and asset bindings, credential or attestation status, evidence commitment, decision, and revocation state.

400The JSON body or required signed headers are malformed.Request must change · JSON RESPONSE+

{
  "code": "invalid_json",
  "message": "The JSON body or required signed headers are malformed."
}

INTEGRATION DECISIONinvalid_json

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. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION: Compare the submitted values with the documented constraints before another call. Refresh the policy version, subject and asset bindings, credential or attestation status, evidence commitment, decision, and revocation state.
ESCALATE WHEN: Escalate when minimized compliance evidence, issuer authority, policy version, jurisdiction, or decision lineage cannot be verified.

401The bearer credential or RFC 9421 request signature is missing, expired, replayed, or invalid.Authentication required · JSON RESPONSE+

{
  "code": "invalid_credentials",
  "message": "The bearer credential or RFC 9421 request signature is missing, expired, replayed, 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. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION: Assume the outcome is unknown only when the connection failed after transmission; otherwise authentication failed before domain work. Refresh the policy version, subject and asset bindings, credential or attestation status, evidence commitment, decision, and revocation state.
ESCALATE WHEN: Escalate when minimized compliance evidence, issuer authority, policy version, jurisdiction, or decision lineage cannot be verified.

403The credential lacks the required compliance:write or compliance:review scope.Authority or policy denied · JSON RESPONSE+

{
  "code": "insufficient_scope",
  "message": "The credential lacks the required compliance:write or compliance:review scope."
}

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 transfer-policy definitions, credentials, attestations, reviews, commitments, decisions, and revocations.
ESCALATE WHEN: Escalate when minimized compliance evidence, issuer authority, policy version, jurisdiction, or decision lineage cannot be verified.

409The Idempotency-Key conflicts with another request or the requested lifecycle transition is forbidden.State reconciliation required · JSON RESPONSE+

{
  "code": "transfer_compliance_conflict",
  "message": "The Idempotency-Key conflicts with another request or the requested lifecycle transition is forbidden."
}

INTEGRATION DECISIONtransfer_compliance_conflict

CALLER ACTION: Stop the mutation sequence and fetch the latest authoritative resource, lifecycle state, version, ETag, reservation, or existing idempotency result.
RETRY SAFETY: Retry only after reconciling the conflict. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION: Refresh the policy version, subject and asset bindings, credential or attestation status, evidence commitment, decision, and revocation state.
ESCALATE WHEN: Escalate when minimized compliance evidence, issuer authority, policy version, jurisdiction, or decision lineage cannot be verified.

422An identifier, field, commitment, public key, evidence object, or Idempotency-Key is outside the documented contract.Request must change · JSON RESPONSE+

{
  "code": "invalid_transfer_compliance_command",
  "message": "An identifier, field, commitment, public key, evidence object, or Idempotency-Key is outside the documented contract."
}

INTEGRATION DECISIONinvalid_transfer_compliance_command

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. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION: Compare the submitted values with the documented constraints before another call. Refresh the policy version, subject and asset bindings, credential or attestation status, evidence commitment, decision, and revocation state.
ESCALATE WHEN: Escalate when minimized compliance evidence, issuer authority, policy version, jurisdiction, or decision lineage cannot be verified.

503The authoritative Core transfer-compliance command boundary is unavailable.Dependency unavailable or outcome uncertain · JSON RESPONSE+

{
  "code": "transfer_compliance_unavailable",
  "message": "The authoritative Core transfer-compliance command boundary is unavailable."
}

INTEGRATION DECISIONtransfer_compliance_unavailable

CALLER ACTION: Preserve the exact request and treat the outcome as uncertain until authoritative state proves whether it committed.
RETRY SAFETY: Reconcile before retrying. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions. Use bounded backoff with jitter.
STATE RECONCILIATION: Refresh the policy version, subject and asset bindings, credential or attestation status, evidence commitment, decision, and revocation state.
ESCALATE WHEN: Escalate when minimized compliance evidence, issuer authority, policy version, jurisdiction, or decision lineage cannot be verified.

OPERATIONAL NOTES

Security and lifecycle guarantees

Canonicalize and encrypt the disclosure payload client-side using the separately verified recipient public key. Submit only digests and commitments; this endpoint accepts no ciphertext or regulated cleartext.
The authorization lifetime is capped at 24 hours and never extends beyond manifest expiry. Re-fetch the manifest and counterparty key before constructing the envelope.
Authorization records intent and binding only. It neither delivers the ciphertext nor proves delivery, decryption, recipient acceptance, screening, transfer approval, settlement, or value movement.
Delivery remains a separate unpublished workflow. Never infer or construct a delivery endpoint from the counterparty projection.

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 ↗