DOCUMENTATIONv2

POST

Transfer compliance

Register counterparty

/api/v2/transfer-compliance/counterparties

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

PURPOSE + BUSINESS CONTEXT

Register a VASP counterparty for review.

WHEN THIS CALL IS USEFUL

Register a VASP or institutional counterparty before due-diligence review, using its DID, current public verification and encryption keys, supported protocols, networks, and private delivery endpoint.

OUTCOME · Create or advance

What changes

Creates a private owner-scoped PENDING directory record and commitment. Registration is not approval, publication, disclosure authority, or transfer authority.

WHY IT MATTERS

Gives people and agents a contract-backed way to advance counterparty.
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 code (body), display_name (body), did (body), signing_key (body), encryption_key (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 counterparty 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 counterparty only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Supply the required code (body), display_name (body), did (body), signing_key (body), encryption_key (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:

codebodyRequired

identifier · 1–64Stable counterparty code.EXAMPLEEXAMPLE_VASP_GB

display_namebodyRequired

string · 1–160Operator-readable VASP name; never use as an authorization key.EXAMPLEExample VASP UK

didbodyRequired

DID · max 255Counterparty decentralized identifier beginning with did:.EXAMPLEdid:hybrid:vasp:example

jurisdictionbodyOptional

identifier · 1–32Operating jurisdiction; defaults to GLOBAL.EXAMPLEGB

regulatory_statusbodyOptional

identifier · 1–64Declared regulatory posture; defaults to UNVERIFIED and remains untrusted until review.EXAMPLEREGISTERED

risk_ratingbodyOptional

identifier · 1–64Initial risk posture; defaults to UNRATED.EXAMPLELOW

supported_protocolsbodyOptional

unique identifier[] · max 50Interoperability protocols; defaults to HYBRID_TRANSFER_V1.EXAMPLE["HYBRID_TRANSFER_V1","TRISA"]

networksbodyOptional

unique identifier[] · max 50Supported settlement-network labels; defaults to HYBRID.EXAMPLE["hybrid-testnet"]

signing_keybodyRequired

public OKP, EC, or RSA JWKComplete public verification key. Private, symmetric, empty, or unsupported JWKs are rejected.EXAMPLE{"kty":"OKP","crv":"Ed25519","kid":"example-signing-2026-09","x":"base64url-public-key"}

encryption_keybodyRequired

public OKP, EC, or RSA JWKComplete public envelope-encryption key. Private, symmetric, empty, or unsupported JWKs are rejected.EXAMPLE{"kty":"OKP","crv":"X25519","kid":"example-encryption-2026-09","x":"base64url-public-key"}

compliance_endpointbodyOptional

HTTPS URL · max 500Private delivery endpoint retained by Core and never returned by the public V2 projection.EXAMPLEhttps://compliance.example.test/hybrid-transfer

REQUEST

JSON body example

{
  "code": "EXAMPLE_VASP_GB",
  "display_name": "Example VASP UK",
  "did": "did:hybrid:vasp:example",
  "jurisdiction": "GB",
  "regulatory_status": "REGISTERED",
  "risk_rating": "LOW",
  "supported_protocols": [
    "HYBRID_TRANSFER_V1",
    "TRISA"
  ],
  "networks": [
    "hybrid-testnet"
  ],
  "signing_key": {
    "kty": "OKP",
    "crv": "Ed25519",
    "kid": "example-signing-2026-09",
    "x": "base64url-public-key"
  },
  "encryption_key": {
    "kty": "OKP",
    "crv": "X25519",
    "kid": "example-encryption-2026-09",
    "x": "base64url-public-key"
  },
  "compliance_endpoint": "https://compliance.example.test/hybrid-transfer"
}

RESPONSES

Status and payload examples

201Canonical owner-scoped PENDING counterparty awaiting due-diligence review; private endpoint omitted.Mutation completed · JSON RESPONSE+

{
  "counterparty_id": "9fe24832bc314df791943cb47d959bb7",
  "code": "EXAMPLE_VASP_GB",
  "display_name": "Example VASP UK",
  "did": "did:hybrid:vasp:example",
  "jurisdiction": "GB",
  "regulatory_status": "REGISTERED",
  "risk_rating": "LOW",
  "supported_protocols": [
    "HYBRID_TRANSFER_V1",
    "TRISA"
  ],
  "networks": [
    "hybrid-testnet",
    "ethereum-mainnet"
  ],
  "signing_key": {
    "kty": "OKP",
    "crv": "Ed25519",
    "kid": "example-signing-2026-09",
    "x": "base64url-public-key"
  },
  "encryption_key": {
    "kty": "OKP",
    "crv": "X25519",
    "kid": "example-encryption-2026-09",
    "x": "base64url-public-key"
  },
  "due_diligence_status": "PENDING",
  "reviewed_at": null,
  "valid_until": null,
  "status": "PENDING",
  "created_at": "2026-08-20T00:00:00Z",
  "updated_at": "2026-08-20T00:00:00Z"
}

INTEGRATION DECISIONEXAMPLE_VASP_GB

CALLER ACTION: Accept the returned representation or receipt, then re-read counterparty 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

Registration creates directory-review state only. Declared regulatory status, risk rating, DID, protocols, networks, and keys do not become trusted merely because the request succeeded.
Only public keys are accepted. Never transmit d, p, q, dp, dq, qi, oth, k, a private key, seed, secret, credential, or ciphertext.
The compliance endpoint remains private to Core. Fetch the public projection after creation and use the stable counterparty_id for later review and reconciliation.
Registration grants no transfer approval, disclosure authorization, delivery, settlement, 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 ↗