DOCUMENTATIONv2

GET

Transfer compliance

Get counterparty

/api/v2/transfer-compliance/counterparties/{counterparty_uuid}

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

PURPOSE + BUSINESS CONTEXT

Reconcile one owner-registered VASP counterparty's interoperability, public-key, risk, due-diligence, validity, and lifecycle posture without exposing its private delivery endpoint.

WHEN THIS CALL IS USEFUL

Use after counterparty collection discovery and immediately before a disclosure or transfer review to reconcile public keys, protocol and network compatibility, due-diligence status, validity, risk, and lifecycle state.

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 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 counterparty_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 counterparty when its observation time, version, or lifecycle state is no longer adequate for the decision.

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 counterparty_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_…

counterparty_uuidpathRequired

32-character identifierStable owner-scoped counterparty identifier returned by the collection route.EXAMPLE9fe24832bc314df791943cb47d959bb7

RESPONSES

Status and payload examples

200One owner-registered counterparty with current interoperability, public-key, risk, due-diligence, validity, and lifecycle posture.Read 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": "CURRENT",
  "reviewed_at": "2026-08-20T00:00:00Z",
  "valid_until": "2027-08-20T00:00:00Z",
  "status": "ACTIVE",
  "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 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.

400The counterparty identifier is not a canonical 32-character value.Request must change · JSON RESPONSE+

{
  "code": "invalid_counterparty_identifier",
  "message": "The counterparty identifier is not a canonical 32-character value."
}

INTEGRATION DECISIONinvalid_counterparty_identifier

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. A corrected read may be sent as a new attempt.
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.

404The counterparty does not exist or is not visible to the authenticated owner.Resource not visible · JSON RESPONSE+

{
  "code": "counterparty_not_found",
  "message": "The counterparty does not exist or is not visible to the authenticated owner."
}

INTEGRATION DECISIONcounterparty_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

Use after collection discovery and re-fetch immediately before a disclosure or transfer review. Match by stable identifier; never use display_name as an authorization or reconciliation key.
Treat ACTIVE plus APPROVED plus an unexpired valid_until as counterparty fitness evidence, not as transfer approval, settlement authorization, or proof that value moved.
Confirm the DID, jurisdiction, supported protocol and network, and current signing_key and encryption_key. Key objects are public interoperability material only; private delivery endpoints and internal owner identifiers are excluded.
The gateway combines the requested identifier with the bearer-derived owner predicate. Another owner's record is not addressable, and 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 ↗