API Reference

Every public operation in the contract, grouped by area. This page is generated from the OpenAPI spec, so it never drifts from the running system. 220 operations across 9 areas. 0 carry a full description. Tiers: 220 customer. Private XKOVA management Console, partner-management, identity-provider ceremony, and browser capability operations are not shown. The 12 member-auth operations are intentionally published as the confidential server protocol behind @xkova/sdk/member-bff; they are not a browser or raw-token interface.

This is the fast, scannable list. For schemas, examples, and a live try it console, open the interactive reference. Guide pages link into these operations.

account_holders 26

Concept guides: Account Holders, Wallets and Balances, Identity Verification (KYC and KYB)

GET /account-holders customer

Search account holders (staff)

POST /account-holders customer

Create an account holder (staff)

GET /account-holders/{id} customer

Get account holder (staff view; broader than /users/{id})

PATCH /account-holders/{id} customer

Update mutable account-holder fields

GET /account-holders/{id}/history customer

Account-holder tx history (staff)

GET /account-holders/self/balance customer

Get the current account holder's wallet balances

GET /account-holders/self/bank-balance customer

Get the current account holder's USD bank (savings) balance

GET /account-holders/self/bank-transactions customer

List the current account holder's internal bank transfers

POST /account-holders/self/bank-transfers customer

Move USD between the account holder's own share savings and share draft

GET /account-holders/self/checking-balance customer

Get the current account holder's USD share-draft (checking) balance

GET /account-holders/self/consents customer

Get the current account holder's consent state

POST /account-holders/self/consents customer

Accept current tenant policies for the current account holder

POST /account-holders/self/data-exports customer

Request a right-to-access data export for the current account holder

GET /account-holders/self/data-exports/{id} customer

Get data export status for the current account holder

GET /account-holders/self/sandbox-banking-context customer

Get the member's sandbox banking references

GET /account-holders/self/transactions customer

List the current account holder's transactions

GET /account-holders/self/verification customer

Get the current member's identity verification status

POST /account-holders/self/wallet-provision customer

Ensure wallet provisioning for the current member

GET /account-holders/self/wallet-readiness customer

Get the current member's wallet readiness

GET /account-holders/self/wallets customer

List the current member's wallets

GET /contacts customer

List account holder's address book

POST /contacts customer

Add a contact

DELETE /contacts/{id} customer

Delete a contact

GET /contacts/{id} customer

Get a contact

PATCH /contacts/{id} customer

Update a contact

POST /contacts/search customer

Look up a contact by email or phone hash

embedded:avatar 4

Concept guides: Account Holders, Wallets and Balances

DELETE /account-holders/{id}/avatar customer

Delete the account holder avatar

GET /account-holders/{id}/avatar customer

Get a short-TTL presigned GET URL for the holder's avatar

POST /account-holders/{id}/avatar/confirm customer

Confirm an avatar upload for the account holder

POST /account-holders/{id}/avatar/upload-url customer

Create a short-lived avatar upload URL

embedded:member_auth 12

Concept guides: Authentication, Wallets and Balances

POST /account-center/handoffs customer

Begin an XKOVA Hosted Account Center handoff

POST /account-center/handoffs/exchange customer

Complete an XKOVA Hosted Account Center handoff

POST /member-actions customer

Begin exact authorization for a protected member action

POST /member-actions/external/complete customer

Complete a protected member action with a fresh FI OIDC proof

POST /member-auth/hosted/authorizations customer

Begin an XKOVA Hosted Auth authorization transaction

POST /member-auth/hosted/authorizations/exchange customer

Exchange a Hosted Auth result for an XKOVA member session

POST /member-auth/hosted/authorizations/sandbox-demo customer

Admit a platform-leased sandbox demo persona

POST /member-auth/proof/challenges customer

Issue a one-time nonce for a registered member-auth application

POST /member-auth/proof/exchange customer

Exchange a verified provider proof for an XKOVA member session

POST /member-auth/refresh customer

Rotate a BFF-held XKOVA member-session refresh credential

GET /member-auth/session customer

Resolve the active XKOVA member session

POST /member-auth/sign-out customer

Revoke the exact XKOVA member session or all current member sessions

funding 7

Concept guides: Conversion and Ramps, Funding and Off-ramp

GET /funding-requests customer

List funding requests for the tenant (paginated, recent first)

POST /funding-requests customer

Create a funding request (fiat → stablecoin via [X] partner)

GET /funding-requests/{id} customer

Get a funding request

GET /off-ramp-requests customer

List off-ramp requests for the tenant (paginated, recent first)

POST /off-ramp-requests customer

Create an off-ramp request (stablecoin → fiat via [X] partner)

GET /off-ramp-requests/{id} customer

Get an off-ramp request

GET /off-ramp-requests/burn-address customer

The on-chain address to burn stablecoin TO when redeeming (off-ramp)

payment 20

Concept guides: Payments, Transfers and Settlement

GET /escrows customer

List the calling tenant's escrows (cursor-paginated, newest first)

POST /escrows customer

Create an escrow (sender-side)

GET /escrows/{id} customer

Get a single escrow

POST /escrows/{id}/cancel customer

Validate that an escrow is ready for a sender-cancel action

GET /escrows/{id}/events customer

Audit-trail timeline for a single escrow

GET /payment-requests customer

List payment requests

POST /payment-requests customer

Create a payment request (recipient-initiated; inbound pay ask)

GET /payment-requests/{id} customer

Get a payment request

POST /payment-requests/{id}/approve customer

Approve a payment request (spawns a payment on the payer side)

POST /payment-requests/{id}/cancel customer

Cancel a payment request (verb-noun alias for DELETE /:id)

POST /payment-requests/{id}/decline customer

Decline a payment request

POST /payment-requests/{id}/remind customer

Nudge the payer with a reminder

GET /payments customer

Tenant-wide payment list (cursor-paginated, rich filters, FTS on memo)

POST /payments customer

Create a payment

GET /payments/{id} customer

Get a payment

POST /payments/{id}/cancel customer

Cancel a payment (pre-sign only)

GET /payments/{id}/events customer

Timeline of state transitions for a payment

POST /payments/quote customer

Get a fee + compliance quote for a prospective payment

POST /payments/simulate customer

Simulate a payment's chain feasibility before signing (dry-run)

GET /transactions customer

List the calling tenant's transactions across every payment-flow kind

platform 20

Concept guides: Overview

GET /integration-gateways customer

List integration gateways

POST /integration-gateways customer

GET /integration-gateways/{id} customer

Get an integration gateway

PATCH /integration-gateways/{id} customer

Edit gateway registration (name / base_url)

POST /integration-gateways/{id}/conformance customer

Record a contract-conformance result for the gateway

GET /integration-gateways/{id}/events customer

List a gateway's invocation events

POST /integration-gateways/{id}/pin-cert customer

Pin or rotate the gateway's mTLS cert fingerprint

POST /integration-gateways/{id}/status customer

Enable or disable an integration gateway

GET /webhook-deliveries customer

List recent webhook deliveries (last 30 days)

GET /webhook-deliveries/{id} customer

Fetch a single webhook delivery

POST /webhook-deliveries/{id}/replay customer

Re-fire a past delivery (preserves original Idempotency-Key)

POST /webhook-deliveries/bulk-replay customer

Bulk re-fire terminal deliveries

GET /webhook-endpoints customer

List webhook endpoints

POST /webhook-endpoints customer

Create a webhook endpoint

DELETE /webhook-endpoints/{id} customer

Delete webhook endpoint

GET /webhook-endpoints/{id} customer

Get webhook endpoint

PATCH /webhook-endpoints/{id} customer

Update webhook endpoint

POST /webhook-endpoints/{id}/rotate customer

Rotate the HMAC signing secret for this endpoint

POST /webhook-endpoints/{id}/test customer

Send a test event to this endpoint

GET /webhook-event-types customer

List subscribable webhook event types

tenant 34

Concept guides: Tenants and Workspaces

GET /branding customer

Get this tenant's resolved branding + the raw tenant-wide theme

PUT /branding customer

Upsert this tenant's branding (tenant-wide)

GET /branding/email-domains customer

List this tenant's custom sending domains + their DNS records

POST /branding/email-domains customer

DELETE /branding/email-domains/{id} customer

Remove a custom sending domain

POST /branding/email-domains/{id}/verify customer

Trigger + refresh verification for a sending domain

DELETE /branding/logo customer

Remove the brand logo

POST /branding/logo customer

Confirm a brand logo upload (magic-byte validated)

POST /branding/logo/upload-url customer

Presigned PUT URL for a brand logo upload

GET /chains/available customer

List every chain automatically available to the calling workspace

GET /fee-schedules customer

List fee schedules for this tenant

POST /fee-schedules customer

Propose a new fee schedule (validates floor enforcement)

GET /fee-schedules/{id} customer

Get a single fee schedule (with effective rules)

GET /fee-schedules/platform-fee customer

Read-only XKOVA platform-fee rule for this workspace

POST /onboarding/setup customer

Record onboarding intent and activate the workspace

GET /onboarding/status customer

Onboarding state for the calling tenant's sandbox workspace

GET /public/branding customer

Public branding for a hosted claim page (pre-auth)

GET /tenant customer

Get tenant config

GET /tenant/member-auth/allowed-origins customer

List allowed browser Origin values for member-auth flows

POST /tenant/member-auth/allowed-origins customer

Allowlist a new browser Origin for member-auth flows

DELETE /tenant/member-auth/allowed-origins/{id} customer

Soft-delete an allowed Origin

PUT /tenant/member-auth/application customer

GET /tenant/member-auth/applications customer

List member-auth applications in the active workspace

DELETE /tenant/member-auth/applications/{id} customer

Disable a member-auth application

PATCH /tenant/member-auth/applications/{id} customer

Update a member-auth application

POST /tenant/member-auth/applications/hosted customer

Enable an XKOVA Hosted Auth application

GET /tenant/member-auth/redirect-urls customer

List redirect URLs for the active member-auth application

POST /tenant/member-auth/redirect-urls customer

Allowlist a new redirect URL for member authentication

DELETE /tenant/member-auth/redirect-urls/{id} customer

Soft-delete an allowed redirect URL

GET /tenant/policies customer

Get tenant policy registry (ToS, privacy, marketing)

GET /workspace-tokens customer

List Rails-authorized tokens for the calling workspace

GET /workspaces customer

List the workspace pair under this tenant

GET /workspaces/{id} customer

Get a single workspace

PATCH /workspaces/{id} customer

Update mutable workspace fields (name and status)

tokenization 90

Concept guides: Overview, Token Standards, Deploy and Mint, Access and Policy, Cap Tables and Distributions, Corporate Actions, Provenance and Transparency, Holder Eligibility and Transfers, Real-World Assets, Asset Templates

GET /rwa/asset-schemas customer

List the workspace's asset schemas

GET /rwa/asset-schemas/{id} customer

Get one workspace asset schema and its version history

POST /rwa/asset-schemas/{id}/publish customer

Publish the workspace schema's open draft

POST /rwa/asset-schemas/compile-preview customer

Compile a field-palette and report the publish-gate verdict

POST /rwa/asset-schemas/draft customer

Save a palette as the workspace schema's editable draft

POST /rwa/asset-schemas/fork customer

Fork a platform template into a workspace draft

GET /rwa/asset-schemas/templates customer

List the forkable platform templates

POST /rwa/asset-schemas/upload-publish customer

Publish a raw JSON Schema through the publish gate

GET /rwa/contracts/{id}/contract-metadata customer

Get a collection's contract metadata (contractURI target)

PUT /rwa/holders/{holderRef}/eligibility customer

Upsert a holder's global eligibility attributes

POST /rwa/schema-rebinds customer

Propose an attested schema-evolution rebind ceremony

GET /rwa/schema-rebinds/{id} customer

Read a rebind ceremony's lifecycle state

POST /rwa/schema-rebinds/{id}/attest customer

Record an EIP-712 attestation over the rebind proposal digest

POST /rwa/schema-rebinds/{id}/commit customer

Commit a rebind - move bindings + re-commit metadata

POST /rwa/schema-rebinds/{id}/dry-run customer

Dry-run a rebind against the target schema (no write)

GET /rwa/tokens/{id}/attesters customer

List a token's registered attesters

POST /rwa/tokens/{id}/attesters customer

DELETE /rwa/tokens/{id}/attesters/{attesterId} customer

Revoke a registered attester (soft)

GET /rwa/tokens/{id}/cap-table customer

Get a token's cap-table summary

POST /rwa/tokens/{id}/corporate-actions customer

Open a corporate action on an RWA token

GET /rwa/tokens/{id}/corporate-actions/{caId} customer

Get a corporate action + its leg progress

POST /rwa/tokens/{id}/corporate-actions/{caId}/advance customer

Advance a corporate action's state machine

POST /rwa/tokens/{id}/distributions customer

Create a pro-rata cap-table distribution

GET /rwa/tokens/{id}/distributions/{distId} customer

Get a distribution + its payouts

POST /rwa/tokens/{id}/distributions/{distId}/execute customer

Execute a draft distribution (treasury-Safe multiSend payout)

POST /rwa/tokens/{id}/document-entitlements customer

Grant a recipient access to a token's gated documents

DELETE /rwa/tokens/{id}/document-entitlements/{grantee} customer

Revoke a recipient's gated-document access

GET /rwa/tokens/{id}/documents/{docId} customer

Resolve an RWA document to a fetch URL

POST /rwa/tokens/{id}/documents/confirm customer

Confirm an uploaded RWA document (integrity + provenance)

POST /rwa/tokens/{id}/documents/upload-url customer

Presign an RWA document upload

GET /rwa/tokens/{id}/eligibility/{holderRef} customer

Read the (token, holder) transfer-eligibility context

GET /rwa/tokens/{id}/fields customer

Describe the token's bound-schema fields + current values

POST /rwa/tokens/{id}/fields/{fieldPath} customer

Commit an operator-authored field value

POST /rwa/tokens/{id}/fields/{fieldPath}/attested-entry customer

Submit an attested append-log fact

GET /rwa/tokens/{id}/holders customer

List a token's cap-table holders

GET /rwa/tokens/{id}/instances customer

List a token's per-instance ownership (NFT gallery)

PUT /rwa/tokens/{id}/lockups/{holderRef} customer

Set a per-holding lockup on an RWA token

GET /rwa/tokens/{id}/log/proof/consistency customer

Get an RFC-6962 consistency proof (public transparency log)

GET /rwa/tokens/{id}/log/proof/inclusion customer

Get an RFC-6962 inclusion proof (public transparency log)

GET /rwa/tokens/{id}/log/sth customer

Get a token's signed tree head (public transparency log)

POST /rwa/tokens/{id}/log/witness customer

Submit a third-party witness co-signature for an STH

GET /rwa/tokens/{id}/metadata customer

Get a token's metadata (ERC-721 tokenURI target)

GET /rwa/tokens/{id}/metadata/{tokenId} customer

Get per-instance metadata (ERC-1155 uri {id} target)

GET /rwa/tokens/{id}/placeholder customer

Get a token's branded placeholder image

GET /rwa/tokens/{id}/provenance/verify customer

Verify a token's metadata provenance chain

GET /rwa/tokens/{id}/relationships customer

List a token's outgoing relationship edges

GET /rwa/tokens/{id}/schema-binding customer

Read the token's bound asset schema

POST /rwa/tokens/{id}/schema-binding customer

Bind a published asset schema to the token

POST /rwa/tokens/{id}/witnesses customer

GET /tokenization/authorities customer

List this workspace's token authorities

POST /tokenization/authorities customer

GET /tokenization/authorities/{id} customer

Get one token authority with its role matrix

POST /tokenization/authorities/{id}/proof customer

Submit a proof-of-possession for a server-key authority

POST /tokenization/authorities/{id}/proof-challenge customer

Issue a proof-of-possession challenge for a server-key authority

POST /tokenization/authorities/control-safes customer

Create a token-control Safe and register it as an authority

POST /tokenization/erc1155 customer

Deploy a customer gasless ERC-1155 (ERC1155X) contract on-chain

POST /tokenization/erc20 customer

Deploy a customer gasless ERC-20 (ERC20X) on-chain

POST /tokenization/erc721 customer

Deploy a customer gasless ERC-721 (ERC721X) collection on-chain

GET /tokenization/tokens customer

List this workspace's customer-deployed tokens

GET /tokenization/tokens/{id} customer

Get a customer-deployed token

POST /tokenization/tokens/{id}/access-list/add customer

Add addresses to a customer token's access list (SAFE-PATH)

POST /tokenization/tokens/{id}/access-list/remove customer

Remove addresses from a customer token's access list (SAFE-PATH)

POST /tokenization/tokens/{id}/access-registry customer

Attach an access registry to an open token (post-deploy)

POST /tokenization/tokens/{id}/access-registry/disable customer

Detach the access registry from a token (SAFE-PATH → open transfers)

POST /tokenization/tokens/{id}/burn customer

Burn a customer token via its admin Safe (SAFE-PATH)

GET /tokenization/tokens/{id}/contracts customer

List a token's explorable control contracts

POST /tokenization/tokens/{id}/deploy/resume customer

Resume a failed_resumable deploy

POST /tokenization/tokens/{id}/deprecate customer

Deprecate a customer token (off-chain retire)

POST /tokenization/tokens/{id}/gasless/relay customer

Relay a signed gasless holder-transfer ForwardRequest

POST /tokenization/tokens/{id}/gasless/transfer-request customer

Build a gasless holder-transfer ForwardRequest

POST /tokenization/tokens/{id}/mint customer

Mint a customer token via its admin Safe (SAFE-PATH)

POST /tokenization/tokens/{id}/nft-transfers customer

Relay a signed gasless holder NFT transfer

POST /tokenization/tokens/{id}/nft-transfers/build customer

Build a gasless holder NFT-transfer ForwardRequest

GET /tokenization/tokens/{id}/operations customer

List a customer token's privileged operations

GET /tokenization/tokens/{id}/operations/{opId} customer

Get one tokenization operation

POST /tokenization/tokens/{id}/operations/{opId}/module-signature customer

Submit the authority's ModuleTx signature for a policy mint

POST /tokenization/tokens/{id}/operations/{opId}/signatures customer

Submit a Safe-owner signature for a tokenization operation

POST /tokenization/tokens/{id}/pause customer

Pause a customer token via its admin Safe (SAFE-PATH circuit breaker)

POST /tokenization/tokens/{id}/policies customer

Set a mint-cap policy for a server-key authority (SAFE-PATH)

POST /tokenization/tokens/{id}/policies/revoke customer

Revoke a server-key authority's mint-cap policy (SAFE-PATH)

POST /tokenization/tokens/{id}/policy-mint customer

Build a policy-scoped gasless mint (ModuleTx)

POST /tokenization/tokens/{id}/raw-safe-tx customer

Build a raw governance SafeTx on one of the token's own contracts (SAFE-PATH escape hatch)

GET /tokenization/tokens/{id}/read customer

Read a view function on a token's control contract

POST /tokenization/tokens/{id}/recover customer

Recover (claw back) tokens from a blocked account (SAFE-PATH)

POST /tokenization/tokens/{id}/roles/grant customer

Grant an ERC20X role via the admin Safe (SAFE-PATH)

POST /tokenization/tokens/{id}/roles/revoke customer

Revoke an ERC20X role via the admin Safe (SAFE-PATH)

POST /tokenization/tokens/{id}/treasury-disable customer

Remove a customer token from this workspace's treasury readers

POST /tokenization/tokens/{id}/treasury-enable customer

Enable a customer token for treasury custody + transfers (workspace-scoped)

GET /tokenization/tokens/{id}/treasury-status customer

Read a customer token's current treasury-eligibility state

POST /tokenization/tokens/{id}/unpause customer

Unpause a customer token via its admin Safe (SAFE-PATH circuit breaker)

wallets 7

Concept guides: Wallets and Balances

GET /account-holders/{id}/wallets customer

List wallets for an account holder

GET /wallets/{id} customer

Get a wallet

GET /wallets/{id}/balance customer

Materialized running balance for a (wallet, chain, token)

POST /wallets/{id}/decommission customer

Decommission a wallet (state=decommissioned; not deleted)

GET /wallets/{id}/history customer

Wallet-scoped payment history (same shape as GET /payments with wallet filter)

GET /wallets/{id}/ledger customer

Bank-statement timeline for a wallet (atomic debits + credits across every token movement)

POST /wallets/{id}/qr customer

Generate a receive QR (EIP-681 + XKOVA extensions) for an explicit wallet

Was this helpful?