# XKOVA Documentation

> XKOVA is software only digital asset management for regulated institutions: XKOVA SPS (the Stablecoin Payment System) and XKOVA TAMS (the Tokenized Asset Management System) on an open orchestration layer. It is non-custodial by construction, API first, and ships with an operator console and member facing apps. This file is the machine readable index of the documentation portal for AI coding agents.

This portal uses plain HTML pages. Links below are relative to the portal root. Every page also offers a Copy page for LLM action in its footer. Pages marked Planned are part of the information architecture but are not written yet.

## Start Here
- [Overview](index.html): What XKOVA is: digital asset management across XKOVA SPS (stablecoin payments) and XKOVA TAMS (tokenized assets).
- [Quickstart](getting-started.html): First authenticated sandbox call and the path to a confirmed payment.
- [Local Development](local-dev.html): Develop your integration locally against the hosted sandbox.
- [Try the Demos](demos.html): The hosted Plover demo: operator console and member app.

## Concepts
- [Platform Overview](concepts.html): The two product pillars, the orchestration layer, the non-custodial model, and how the pieces fit.
- [Non-custodial Model](non-custodial.html): EIP-712 member signing and relayer submission.
- [Tenants and Workspaces](tenancy.html): The isolation scopes for identity and operational data.
- [Supported Networks](networks.html): Chains, tokens, and the multichain posture.
- [Wallets and Balances](wallets.html): Member wallets, custody model, and balances.
- [Account Holders](account-holders.html): The member record behind every wallet: provisioning, self-service, consents, exports, and holds.

## XKOVA SPS
- [Overview](rails-overview.html): Move stablecoin value, non-custodially, across the rails.
- [Payments](payments.html): Direct sends and payment requests.
- [Escrow and Claims](escrow.html): Escrowed payments and recipient claims.
- [Treasury](treasury.html): Safe vaults and N of M signer transfers.
- [Transfers and Settlement](transfers.html): How a transfer settles and confirms on chain.
- [Funding and Off-ramp](off-ramp.html): Funding in and cashing out.
- [Fees and Pricing](fee-schedules.html): Fee schedules: the draft to commit lifecycle, earned versus platform fees, and the revenue treasury prerequisite.

## XKOVA TAMS
- [Overview](tokenization-overview.html): The tokenization engine: programmable tokens and real-world assets.
- [Token Standards](token-standards.html): ERC20X, ERC721X, and ERC1155X, the gasless meta-tx token model.
- [Deploy and Mint](deploy-mint.html): Deploy a token, mint, burn, and manage supply.
- [Access and Policy](token-access.html): Allow and deny lists, roles, caps, and pause.
- [Token Authorities](token-authorities.html): Register token authorities, prove key possession, and scope minter service accounts.
- [Real-World Assets](rwa.html): Asset schemas and metadata, config not code, immutable by design.
- [Asset Templates](rwa-templates.html): The 13 curated asset schema templates, from real estate to fund shares.
- [Cap Tables and Distributions](cap-tables.html): Holders, positions, and pro-rata distributions.
- [Corporate Actions](corporate-actions.html): Splits, redemptions, and the lifecycle engine.
- [Provenance and Transparency](provenance.html): Attestation, the transparency log, and reconciliation.
- [Holder Eligibility and Transfers](holder-eligibility.html): Eligibility attributes and transfer policy.

## Integrations and Orchestration
- [Overview](integrations-overview.html): XKOVA as an orchestration layer: swappable vendor adapters, no lock-in.
- [Core Banking](core-banking.html): Connect your core banking system through the integration gateway.
- [Screening (KYT and BSA)](screening.html): Transaction screening and sanctions through interchangeable providers.
- [Identity Verification (KYC and KYB)](verification.html): KYC and KYB through interchangeable identity providers.
- [Conversion and Ramps](conversion.html): Fiat to digital conversion and on and off ramps through partners.
- [Wallet Providers](wallet-providers.html): Custodial and non-custodial wallet vendors, configured per tenant.
- [Branding](branding.html): Theme, logo, and email sending-domain APIs, and the public pre-auth branding read.

## Console User Guide
- [Operator Onboarding](onboarding.html): Signup, magic link, intent fork, token setup, and the first payment checklist.
- [Payments](console-payments.html): Send and manage payments from the console.
- [Treasury](console-treasury.html): Manage treasury vaults and signers from the console.
- [Tokens and Assets](console-tokens.html): Deploy and manage tokens and assets from the console.
- [Compliance](console-compliance.html): Case triage, hold, and release.
- [Settings and Branding](console-settings.html): Team, API keys, fee schedules, and branding.

## Developer Guide
- [Authentication](auth.html): API keys and bearer tokens, federated and bring your own identity.
- [Authorization and RBAC](authz.html): Roles, permissions, and scopes.
- [Embedded Member Integration](embedded-member.html): Browser member flows: the claim ceremony, member sessions, signing sessions, and avatars.
- [Idempotency](idempotency.html): Idempotency keys and safe retries.
- [Pagination](pagination.html): Cursor pagination.
- [Errors and Correlation IDs](errors.html): The error envelope and the catalog of live error codes.
- [Rate Limits](rate-limits.html): Rate limit headers and backoff.
- [Webhooks](webhooks.html): Events, signature verification, retries, replay, and the event catalog.
- [Sandbox Scenarios](sandbox-scenarios.html): Force every outcome deterministically: screening, verification, ramps, faucet, held approvals.
- [Plan and Add-on Entitlements](entitlements.html): How plan and add-on entitlements gate features, code redemption, and the feature_not_enabled contract.

## API Reference
- [All Operations](api-reference.html): The fast, scannable list of every public operation, generated from the contract.
- [Interactive Reference](reference.html): The deep reference with schemas and a live try it console.
- [Recipes and Examples](recipes.html): Task oriented integration flows.

## SDK Reference
- [SDK Overview](sdk-overview.html): The TypeScript client, namespaces, and helpers.
- [Workflows](sdk-workflows.html): The workflow client methods.

## Security and Compliance
- [Security Model](security.html): The non-custodial threat model and key handling.
- [Roles and Permissions](roles-permissions.html): The role model and the full permission catalog, generated from the registry.
- [Policies and Quorum Governance](policies-quorum.html): The policy firewall, approval quorums, and break glass.
- [Break-Glass Emergency Access](break-glass.html): The time-boxed, two-principal emergency valve for governed actions, fully audited.
- [Audit Log](audit-log.html): What the audit trail records.
- [Reporting and Exports](reporting.html): Operator reports, revenue reads, and treasury tax exports for reportable counterparties.
- [Key Management](key-management.html): Signing keys, rotation, and secrets.

## Resources
- [Glossary](glossary.html): Definitions of the recurring platform terms.
- [Changelog](changelog.html): Release notes.
- [Deprecations](deprecations.html): Sunset notices and migration guidance.
- [Versioning](versioning.html): The API versioning and backwards compatibility policy.
- [FAQ and Troubleshooting](faq.html): Common questions and failure recovery.
- [Support](support.html): Support boundaries and how to get help.
- [llms.txt](llms.txt): The machine readable index for AI agents.