DOCUMENTATIONv2

GET

Transfer compliance

Get transfer

/api/v2/transfer-compliance/transfers/{transfer_uuid}

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

PURPOSE + BUSINESS CONTEXT

Return one transfer's compliance decision and retained evidence.

WHEN THIS CALL IS USEFUL

Call this when a transfer originator, beneficiary integration, VASP, compliance reviewer, or disclosure agent needs to inspect one specific transfer before presenting it or making a dependent decision so it can satisfy the minimum applicable counterparty, credential, wallet-control, preparation, decision, and disclosure requirements for one transfer lifecycle.

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 transfer.
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) exactly as defined by the live contract.
Resolve the transfer parties, network, policy jurisdiction, required credential and proof classes, disclosure purpose, recipient, and retention basis.

WHAT TO DO NEXT

Re-read the transfer and credential state, verify purpose and recipient binding, and disclose only the fields required by the current policy stage.
Refresh transfer when its observation time, version, or lifecycle state is no longer adequate for the decision.

AGENT GUIDANCE

Use transfer 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) 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.
Use response links and canonical identifiers instead of constructing internal service URLs or scraping the website.

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

transfer_uuidpathRequired

32-character identifierStable caller-owned transfer intent identifier returned by the collection route.EXAMPLE61d9d2f6d6ab4be6b1d11d6193236f71

RESPONSES

Status and payload examples

200One caller-owned transfer with retained minimized compliance evidence.Read completed · JSON RESPONSE+

{
  "transfer_id": "61d9d2f6d6ab4be6b1d11d6193236f71",
  "direction": "OUTBOUND",
  "asset": "USDC",
  "network": "hybrid-testnet",
  "amount": "12500.00",
  "counterparty_id": "9fe24832bc314df791943cb47d959bb7",
  "origin_jurisdiction": "US",
  "destination_jurisdiction": "GB",
  "state": "REVIEW",
  "policy": {
    "schema": "hybrid-transfer-policy-v1",
    "version": "2026-09-01",
    "required_claims": [
      "originator.name",
      "originator.account",
      "beneficiary.name"
    ]
  },
  "policy_commitment": "sha256:1111111111111111111111111111111111111111111111111111111111111111",
  "current_event_hash": "sha256:2222222222222222222222222222222222222222222222222222222222222222",
  "expires_at": "2026-09-02T18:00:00Z",
  "created_at": "2026-09-01T17:40:00Z",
  "updated_at": "2026-09-01T17:45:00Z",
  "proof_state": "INTACT",
  "participants": [
    {
      "participant_id": "participant-originator",
      "role": "ORIGINATOR",
      "counterparty_id": "9fe24832bc314df791943cb47d959bb7",
      "credential_id": "credential-originator",
      "disclosure_manifest_commitment": "sha256:3333333333333333333333333333333333333333333333333333333333333333",
      "wallet_proof_commitment": "sha256:4444444444444444444444444444444444444444444444444444444444444444",
      "status": "READY",
      "created_at": "2026-09-01T17:40:00Z",
      "updated_at": "2026-09-01T17:44:00Z"
    }
  ],
  "events": [
    {
      "event_id": "event-review",
      "sequence": 4,
      "event_type": "REVIEW_REQUESTED",
      "from_state": "SCREENING",
      "to_state": "REVIEW",
      "evidence_commitments": {
        "screening_commitment": "sha256:5555555555555555555555555555555555555555555555555555555555555555",
        "policy_commitment": "sha256:1111111111111111111111111111111111111111111111111111111111111111"
      },
      "value_moved": false,
      "previous_event_hash": "sha256:6666666666666666666666666666666666666666666666666666666666666666",
      "event_hash": "sha256:2222222222222222222222222222222222222222222222222222222222222222",
      "signature_algorithm": "Ed25519",
      "signature_key_id": "transfer-evidence-2026-09",
      "signature": "base64url-signature",
      "created_at": "2026-09-01T17:45:00Z"
    }
  ],
  "policy_decisions": [
    {
      "decision_id": "decision-screening",
      "decision": "REVIEW_REQUIRED",
      "risk_level": "MEDIUM",
      "reason_codes": [
        "COUNTERPARTY_REVIEW"
      ],
      "input_commitment": "sha256:7777777777777777777777777777777777777777777777777777777777777777",
      "screening_commitment": "sha256:5555555555555555555555555555555555555555555555555555555555555555",
      "decision_commitment": "sha256:8888888888888888888888888888888888888888888888888888888888888888",
      "signature_algorithm": "Ed25519",
      "signature_key_id": "compliance-policy-2026-09",
      "signature": "base64url-signature",
      "created_at": "2026-09-01T17:44:30Z"
    }
  ],
  "reviews": [],
  "message_evidence": [
    {
      "message_id": "message-disclosure",
      "direction": "OUTBOUND",
      "message_type": "TRAVEL_RULE_DISCLOSURE",
      "protocol": "HYBRID_TRANSFER_V1",
      "payload_schema": "IVMS101_2023",
      "payload_commitment": "sha256:9999999999999999999999999999999999999999999999999999999999999999",
      "envelope_commitment": "sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "delivery_status": "QUEUED",
      "attempt_count": 0,
      "created_at": "2026-09-01T17:44:40Z",
      "updated_at": "2026-09-01T17:44:40Z"
    }
  ]
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then re-read the transfer and credential state, verify purpose and recipient binding, and disclose only the fields required by the current policy stage.
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. 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.

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

{
  "code": "invalid_credentials",
  "message": "The bearer credential is missing, expired, 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 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.

403The credential lacks explicitly provisioned compliance:read authority.Authority or policy denied · JSON RESPONSE+

{
  "code": "insufficient_scope",
  "message": "The credential lacks explicitly provisioned compliance:read authority."
}

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.

503The authoritative Core or Identity compliance projection is unavailable.Dependency unavailable or outcome uncertain · JSON RESPONSE+

{
  "code": "transfer_compliance_unavailable",
  "message": "The authoritative Core or Identity compliance projection is unavailable."
}

INTEGRATION DECISIONtransfer_compliance_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: 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

Interpret current state together with the exact policy version, required claims, participant commitments, signed decisions, reviews, message delivery posture, and expiry.
A decision such as APPROVED is compliance evidence only. This read cannot sign, authorize settlement, broadcast, change transfer state, or move value.
Re-fetch after any separately authorized state transition; never infer or manufacture the next event. Responses are no-store.

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 ↗