POST

Transfer compliance

Request vasp credential

/api/v2/transfer-compliance/vasp-credentials

AUTHENTICATIONBearer token · compliance:writeService ownertransfer-compliance-serviceContract sourceOpenAPISTATUSProduction listed

Purpose and usage

What this endpoint does

Create a pending institutional credential commitment for issuer review.

When to use it

Call this when a transfer originator, beneficiary integration, VASP, compliance reviewer, or disclosure agent needs to apply the documented vasp credential transition after re-reading the current authoritative state so it can satisfy the minimum applicable counterparty, credential, wallet-control, preparation, decision, and disclosure requirements for one transfer lifecycle.

OUTCOME · Create or advance

What changes

Creates or advances only the vasp credential resource described by this contract after authorization, validation, policy, and idempotency gates pass.

WHY IT MATTERS

Gives people and agents a contract-backed way to advance vasp credential.
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 did (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 vasp credential 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 vasp credential only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Supply the required did (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.

Contract reference

Use the deployed OpenAPI for exact parameters, schemas and security requirements. The tables below provide integration guidance.

Open this operation in OpenAPI

Request and response

Make the request

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:

didbodyRequired

DID · max 255Institutional DID submitted as a candidate.EXAMPLEdid:web:vasp.example

jurisdictionbodyOptional

jurisdiction identifier · max 16Operating jurisdiction; defaults to GLOBAL.EXAMPLECH

legal_entity_identifierbodyOptional

non-whitespace string · max 96Optional LEI or comparable institutional identifier.EXAMPLE529900EXAMPLE

regulatory_statusbodyOptional

identifier · max 32Claimed posture; defaults to UNVERIFIED and remains untrusted until separately reviewed.EXAMPLELICENSED

REQUEST

JSON body example

{
  "did": "did:web:vasp.example",
  "jurisdiction": "CH",
  "legal_entity_identifier": "529900EXAMPLE",
  "regulatory_status": "LICENSED"
}

RESPONSES

Status and payload examples

201PENDING institutional candidate and canonical commitment; no credential has been issued.Mutation completed · JSON RESPONSE+

{
  "credential_id": "ffffffffffffffffffffffffffffffff",
  "legal_entity_identifier": "529900EXAMPLE",
  "did": "did:web:vasp.example",
  "jurisdiction": "CH",
  "regulatory_status": "LICENSED",
  "credential_commitment": "7777777777777777777777777777777777777777777777777777777777777777",
  "status": "PENDING",
  "valid_until": null,
  "revoked_at": null,
  "created_at": "2026-09-01T18:00:00Z",
  "updated_at": "2026-09-01T18:00:00Z"
}

INTEGRATION DECISION

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

Use this to register a candidate institutional identity for a later issuer workflow, not to self-issue a trusted credential.
status=PENDING and a credential_commitment do not prove licensing, regulatory standing, ownership of the DID, counterparty approval, or transfer eligibility.
Formal credential issuance remains a distinct planned operation with separate issuer authentication and evidence review. Agents must not promote claimed regulatory_status into trusted policy input.
Exact retries replay the original candidate. Re-read the portfolio for later status changes rather than assuming a review outcome.

Reference version and availability details

This route is implemented in canonical gateway source and appears in the production OpenAPI snapshot observed 2026-10-02T23:27:55.510Z. Authentication, tenant, feature, venue, and market policy still apply.

Verify the exact production OpenAPI operation Return to the V2 directory