HYBRID-CHAINDEVELOPERS
DOCUMENTATIONv2
POST

Transfer compliance

Record transfer decision

/api/v2/transfer-compliance/transfers/{transfer_uuid}/decisions
AUTHENTICATIONBearer token · compliance:reviewAUTHORITATIVE OWNERtransfer-compliance-serviceCONTRACT AUTHORITYGenerated Rust OpenAPISTATUSSource ready · production listed

PURPOSE + BUSINESS CONTEXT

Record an authorized compliance decision for a held transfer.

WHEN THIS CALL IS USEFUL

Use only from SCREENING within a separately authorized reviewer or evaluator workflow after screening systems have retained the underlying evidence elsewhere.

OUTCOME · Create or advance

What changes

Derives CLEAR, REVIEW, or REJECT from public-safe outcomes and counterparty fitness; signs and retains the decision and event commitments; and may advance to REVIEW or REJECTED. It never stores raw screening matches.

WHY IT MATTERS

  • Gives people and agents a contract-backed way to advance record transfer decision.
  • 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 transfer_uuid (path), screening_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 record transfer decision 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 record transfer decision only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
  • Supply the required transfer_uuid (path), screening_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:review 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:

transfer_uuidpathRequired

32-character hexadecimal identifierCaller-owned transfer currently in SCREENING.EXAMPLE61d9d2f6d6ab4be6b1d11d6193236f71

sanctions_statusbodyOptional

CLEAR | MATCH | REJECTED | BLOCKED | UNKNOWNPublic-safe sanctions outcome; defaults to UNKNOWN.EXAMPLECLEAR

wallet_risk_statusbodyOptional

CLEAR | LOW | ACCEPTABLE | REJECTED | BLOCKED | PROHIBITED | UNKNOWNPublic-safe wallet-risk outcome; defaults to UNKNOWN.EXAMPLELOW

screening_commitmentbodyRequired

64-character SHA-256 hex digestCommitment to the underlying screening evidence. Raw match data is never accepted.EXAMPLE5555555555555555555555555555555555555555555555555555555555555555

REQUEST

JSON body example

{
  "sanctions_status": "CLEAR",
  "wallet_risk_status": "LOW",
  "screening_commitment": "5555555555555555555555555555555555555555555555555555555555555555"
}

RESPONSES

Status and payload examples

200Signed, provenance-bearing public-safe policy decision and resulting lifecycle state.Mutation completed · JSON RESPONSE+
{
  "decision_id": "decision-screening",
  "transfer_id": "61d9d2f6d6ab4be6b1d11d6193236f71",
  "decision": "REVIEW_REQUIRED",
  "risk_level": "MEDIUM",
  "reason_codes": [
    "COUNTERPARTY_REVIEW"
  ],
  "input_commitment": "7777777777777777777777777777777777777777777777777777777777777777",
  "screening_commitment": "5555555555555555555555555555555555555555555555555555555555555555",
  "decision_commitment": "8888888888888888888888888888888888888888888888888888888888888888",
  "signature_algorithm": "Ed25519",
  "signature_key_id": "compliance-policy-2026-09",
  "signature": "base64url-signature",
  "state": "REVIEW",
  "event": {
    "event_id": "event-screening",
    "sequence": 3,
    "event_type": "POLICY_EVALUATED",
    "from_state": "SCREENING",
    "to_state": "REVIEW",
    "evidence_commitments": {
      "disclosure_manifest_commitment": "3333333333333333333333333333333333333333333333333333333333333333",
      "wallet_proof_commitment": "4444444444444444444444444444444444444444444444444444444444444444"
    },
    "value_moved": false,
    "previous_event_hash": "6666666666666666666666666666666666666666666666666666666666666666",
    "event_hash": "2222222222222222222222222222222222222222222222222222222222222222",
    "signature_algorithm": "Ed25519",
    "signature_key_id": "transfer-evidence-2026-09",
    "signature": "base64url-signature",
    "created_at": "2026-09-01T17:44:00Z"
  },
  "created_at": "2026-09-01T17:44:30Z"
}
INTEGRATION DECISION
CALLER ACTION
Accept the returned representation or receipt, then re-read record transfer decision 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.
404The transfer does not exist or is not visible to the authenticated owner.Resource not visible · JSON RESPONSE+
{
  "code": "transfer_not_found",
  "message": "The transfer does not exist or is not visible to the authenticated owner."
}
INTEGRATION DECISIONtransfer_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
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.
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

  • This is a reviewer-only policy evaluation. The authenticated reviewer profile is derived from the bearer and signed into the Core command; caller-supplied actor identity is not accepted.
  • CLEAR inputs may produce APPROVED, while uncertainty may produce REVIEW_REQUIRED and a REVIEW state. Use the returned decision, risk level, reason codes, commitments, and state; never infer the outcome locally.
  • APPROVED is compliance evidence only. It grants no wallet, signing, matching, publisher, ingress, broadcast, settlement, market-status, traffic, or value-movement authority.
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