DOCUMENTATIONv2

GET

Transfer compliance

List credentials

/api/v2/transfer-compliance/credentials

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

PURPOSE + BUSINESS CONTEXT

List transfer credentials and selective-disclosure manifests.

WHEN THIS CALL IS USEFUL

Call this when a transfer originator, beneficiary integration, VASP, compliance reviewer, or disclosure agent needs to discover credentials and choose a canonical record for a later step so it can satisfy the minimum applicable counterparty, credential, wallet-control, preparation, decision, and disclosure requirements for one transfer lifecycle.

OUTCOME · Discover

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 discover credentials.
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.
Use the live OpenAPI schema as the authority for the exact request shape and response model.
Resolve the transfer parties, network, policy jurisdiction, required credential and proof classes, disclosure purpose, recipient, and retention basis.

WHAT TO DO NEXT

Select one canonical identifier from the response and open its detail operation when the live contract exposes one.
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 credentials only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Use the live OpenAPI schema as the authority for the exact request shape and response model.
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_…

RESPONSES

Status and payload examples

200Authenticated profile's commitment-only formal identity, wallet-control, selective-disclosure, VASP, envelope-authorization, and IVMS101 readiness portfolio.Read completed · JSON RESPONSE+

{
  "primary_vault_id": "2ec4cd41a4414292bb33f040605a6231",
  "credentials": [
    {
      "credential_id": "cccccccccccccccccccccccccccccccc",
      "vault_id": "2ec4cd41a4414292bb33f040605a6231",
      "issuer": "did:hybrid:issuer:identity",
      "status": "VALID",
      "valid_from": "2026-08-01T00:00:00Z",
      "valid_until": "2027-08-01T00:00:00Z",
      "updated_at": "2026-08-01T00:00:00Z",
      "claim_keys": [
        "originator.name",
        "originator.account",
        "originator.national_identifier"
      ],
      "claim_commitments": {
        "originator.name": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
        "originator.account": "cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc",
        "originator.national_identifier": "dddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd"
      }
    }
  ],
  "wallet_proofs": [
    {
      "proof_id": "dddddddddddddddddddddddddddddddd",
      "vault_id": "2ec4cd41a4414292bb33f040605a6231",
      "network": "HYBRID-TESTNET",
      "wallet_reference": "wallet-ref-owner-01",
      "verification_method": "SIGNED_CHALLENGE",
      "challenge_commitment": "eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
      "proof_commitment": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
      "status": "VALID",
      "valid_until": "2026-12-01T00:00:00Z",
      "created_at": "2026-09-01T16:00:00Z",
      "updated_at": "2026-09-01T16:00:00Z"
    }
  ],
  "disclosure_manifests": [
    {
      "manifest_id": "eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
      "credential_id": "cccccccccccccccccccccccccccccccc",
      "counterparty_did": "did:hybrid:vasp:example",
      "purpose": "TRAVEL_RULE_TRANSFER",
      "claim_keys": [
        "originator.name",
        "originator.account"
      ],
      "claim_commitments": {
        "originator.name": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
        "originator.account": "cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc"
      },
      "consent_commitment": "0000000000000000000000000000000000000000000000000000000000000000",
      "manifest_commitment": "1111111111111111111111111111111111111111111111111111111111111111",
      "status": "VALID",
      "valid_until": "2026-09-02T18:00:00Z",
      "created_at": "2026-09-01T17:30:00Z",
      "updated_at": "2026-09-01T17:30:00Z"
    }
  ],
  "vasp_credentials": [],
  "envelope_authorizations": [],
  "ivms101": {
    "schema": "IVMS101_2023",
    "supported": true,
    "claim_groups": [
      "originator",
      "beneficiary"
    ],
    "missing_claim_groups": [],
    "ready_for_originator_payload": true,
    "cleartext_exposed": false
  },
  "readiness": {
    "formal_identity": true,
    "wallet_control": true,
    "transfer_ready": true,
    "public_cleartext_exposed": false
  }
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then select one canonical identifier from the response and open its detail operation when the live contract exposes one.
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.

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

Claim keys and commitments are returned, never claim cleartext or the raw credential. Envelope entries contain ciphertext digests and authorization commitments, not ciphertext.
readiness.transfer_ready means usable formal-identity and wallet-control evidence exists. It is not a transfer decision, counterparty acceptance, signing permit, or settlement authority.
ivms101.ready_for_originator_payload means required claim groups appear available for a future purpose-bound disclosure. It neither reveals nor authorizes disclosure of those claims.
Opaque vault and wallet references may identify the authenticated owner's own records. Treat them as private correlation identifiers and do not place them in shared caches, logs, prompts, or analytics. No profile selector or request body is accepted; 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 ↗