HYBRID-CHAINDEVELOPERS
DOCUMENTATIONv2

TRUST & DATA · MODULE 23

Transfer Compliance

Create and inspect owner-scoped regulated-transfer workflows, commitment-only identity and wallet readiness, VASP counterparty interoperability, signed policy decisions, reviews, and delivery evidence without exposing Travel Rule cleartext or granting settlement authority.

BUSINESS CASES

Where this module fits

  • Travel Rule and IVMS101 orchestration
  • counterparty screening and key selection
  • pre-settlement transfer eligibility
  • credential and wallet-control readiness
  • signed compliance evidence reconciliation

PRIMARY CONSUMERS

Who integrates it

  • compliance teams
  • VASP and payment integrations
  • treasury and custody controls
  • transfer agents
  • audit and reconciliation agents

PREREQUISITES

What must exist first

  • an authenticated owner profile
  • compliance:read for reads, compliance:write for subject workflow commands, or compliance:review for decisions
  • RFC 9421 request signing and a stable Idempotency-Key for every command
  • a defined jurisdictional and transfer policy
  • caller-owned acceptance rules for credentials, counterparties, evidence freshness, and state

RECOMMENDED WORKFLOW

Compose the module safely.

  1. 01

    confirm the sixteen public transfer-compliance contracts in deployed OpenAPI and authenticate with the least-privilege compliance scope

  2. 02

    inspect credential and IVMS101 readiness without requesting regulated cleartext

  3. 03

    register wallet-control evidence, create a consent-bound disclosure manifest, register a VASP candidate when needed, and authorize only the digest of a client-side encrypted envelope

  4. 04

    register or select a VASP counterparty, then re-fetch it to validate status, due diligence, protocol, network, jurisdiction, validity, and public keys

  5. 05

    create an idempotent transfer intent, prepare required evidence, and submit only credential and proof commitments for screening

  6. 06

    record reviewer decisions under compliance:review, retain exact commitments and receipts, and re-fetch state before any separately authorized consequential action

MODULE CONTRACTS

Every mapped endpoint

Each operation states whether its request shape is authoritative in OpenAPI, reviewed as a planning profile, or intentionally left as an outline pending an owner schema.

GETGet subject transfer credentials/api/v2/identity/transfer-credentials/subject/profile/{profile_uuid}Planned capability: return manage subject transfer credentials through the authoritative trust service boundary.POSTUpdate subject transfer credentials/api/v2/identity/transfer-credentials/subject/profile/{profile_uuid}Planned capability: apply the requested transition to manage subject transfer credentials through the authoritative trust service boundary.GETList counterparties/api/v2/transfer-compliance/counterpartiesList VASP counterparties and interoperability posture.POSTRegister counterparty/api/v2/transfer-compliance/counterpartiesRegister a VASP counterparty for review.GETGet counterparty/api/v2/transfer-compliance/counterparties/{counterparty_uuid}Reconcile one owner-registered VASP counterparty's interoperability, public-key, risk, due-diligence, validity, and lifecycle posture without exposing its private delivery endpoint.POSTReview counterparty/api/v2/transfer-compliance/counterparties/{counterparty_uuid}/decisionsApprove, reject, request information for, or suspend a counterparty directory record.GETList credentials/api/v2/transfer-compliance/credentialsList transfer credentials and selective-disclosure manifests.POSTIssue credential/api/v2/transfer-compliance/credentialsPlanned capability: issue a scoped transfer credential from an authorized trust boundary.POSTAuthorize disclosure envelope/api/v2/transfer-compliance/disclosure-envelopesEncrypt and queue an authorized disclosure envelope for an approved counterparty key.POSTCreate disclosure manifest/api/v2/transfer-compliance/disclosure-manifestsCreate a purpose-, counterparty-, claim-, and expiry-bound selective-disclosure manifest.GETList reviews/api/v2/transfer-compliance/reviewsPlanned capability: list transfers and counterparties awaiting authorized review.GETList transfers/api/v2/transfer-compliance/transfersList transfers with their travel-rule and credential posture.POSTCreate transfer intent/api/v2/transfer-compliance/transfersRecord an inbound or outbound regulated transfer intent without broadcasting value.GETGet transfer/api/v2/transfer-compliance/transfers/{transfer_uuid}Return one transfer's compliance decision and retained evidence.POSTCancel transfer intent/api/v2/transfer-compliance/transfers/{transfer_uuid}/cancellationsCancel an eligible transfer intent before authorization and broadcast.POSTRecord transfer decision/api/v2/transfer-compliance/transfers/{transfer_uuid}/decisionsRecord an authorized compliance decision for a held transfer.POSTSubmit disclosure/api/v2/transfer-compliance/transfers/{transfer_uuid}/disclosuresSubmit a consent-bound minimized disclosure package for screening.POSTPrepare required data/api/v2/transfer-compliance/transfers/{transfer_uuid}/preparationsCalculate the minimum credential and counterparty evidence required for a transfer.POSTRequest vasp credential/api/v2/transfer-compliance/vasp-credentialsCreate a pending institutional credential commitment for issuer review.POSTRegister wallet proof/api/v2/transfer-compliance/wallet-control-proofsRegister externally completed signed-challenge commitments without accepting private keys.GETList transfer counterparties/api/v2/explorer/counterpartiesList transfer counterparties from the public Explorer read model, with the identifiers and verification metadata defined by the live contract.GETGet transfer counterparty/api/v2/explorer/counterparties/{counterparty_uuid}Return transfer counterparty from the public Explorer read model, with the identifiers and verification metadata defined by the live contract.GETList transfer compliance records/api/v2/explorer/transfersList transfer compliance records from the public Explorer read model, with the identifiers and verification metadata defined by the live contract.GETGet transfer record/api/v2/explorer/transfers/{transfer_uuid}Return transfer compliance record from the public Explorer read model, with the identifiers and verification metadata defined by the live contract.GETGet transfer compliance MPC authorization/api/v2/explorer/transfers/mpc-authorizations/{authorization_uuid}Return transfer compliance mpc authorization from the public Explorer read model, with the identifiers and verification metadata defined by the live contract.