# Veilo Documentation

> Official documentation for Veilo, a privacy layer on Solana, and the Cloak API for embedding private token transfers into partner products.

Use the Veilo Documentation section for product concepts, user flows, privacy guarantees, and wallet behavior. Use the Cloak API section for partner onboarding, authentication, API endpoints, signing, fees, limits, and operational guidance.

Cloak production endpoints use `https://api.veilo.network/cloak/v1`. Partner accounts, API keys, fee wallets, and metrics are managed at `https://partners.veilo.network`.

## Veilo Documentation

- [Get started: Introduction](https://docs.veilo.network): What Veilo is: a privacy layer on Solana that breaks the link between your identity and how you move money.
- [Get started: Quickstart](https://docs.veilo.network/quickstart): Create an account, fund it, and make your first private transfer.
- [Get started: Apps & clients](https://docs.veilo.network/apps): The mobile wallet, browser extension and web app, plus usernames, multiple accounts and encrypted backup.
- [Core concepts: How Veilo works](https://docs.veilo.network/concepts/how-it-works): How a deposit becomes private, what the proof actually proves, and why funds cannot be spent twice.
- [Core concepts: Architecture](https://docs.veilo.network/concepts/architecture): The on-chain program, the off-chain services and your own device, and what each one is trusted with.
- [Core concepts: Notes & private balance](https://docs.veilo.network/concepts/notes): Why a private balance is stored as notes, and what happens when they are split and merged.
- [Core concepts: Relayers](https://docs.veilo.network/concepts/relayers): Why someone else submits your transaction, what a relayer can and cannot do, and how the set is governed.
- [Core workflow: Deposit](https://docs.veilo.network/flows/deposit): Move funds from a public wallet into the pool, including the gasless path for wallets with no SOL.
- [Core workflow: Withdraw](https://docs.veilo.network/flows/withdraw): Spend from the pool to any Solana address, and what a withdrawal does and does not reveal.
- [Core workflow: Private transfer](https://docs.veilo.network/flows/private-transfer): Send to another Veilo user entirely inside the pool, with no public address involved.
- [Core workflow: Private swap](https://docs.veilo.network/flows/private-swap): Swap between assets without either leg being linked to a wallet you control.
- [Core workflow: Cross-chain](https://docs.veilo.network/flows/cross-chain): Deliver proceeds from a private balance to an address on Ethereum, Base, Arbitrum and other chains.
- [Private execution: Overview](https://docs.veilo.network/execution): How a private balance can trade, hold positions and spend, without revealing who is behind it.
- [Private execution: Positions & tokenized assets](https://docs.veilo.network/execution/positions): Spot positions and tokenized equities, ETFs and commodities, held from a private balance.
- [Private execution: Perpetuals](https://docs.veilo.network/execution/perps): Leveraged long and short positions with take-profit and stop-loss, funded by private USDC.
- [Private execution: Prediction markets](https://docs.veilo.network/execution/predictions): Yes or no positions on real-world events, priced as probability and settled from a private balance.
- [Private execution: Cards, raises & limit orders](https://docs.veilo.network/execution/more): Card spending, token raises, limit orders and the venues private execution reaches next.
- [Rewards: Stars](https://docs.veilo.network/rewards/stars): How stars are earned, which actions pay the most, and how balance differs from lifetime.
- [Rewards: Ranks](https://docs.veilo.network/rewards/ranks): The eight-step ladder, the earning multiplier each rank applies, and what each tier unlocks.
- [Rewards: Star Season & leaderboard](https://docs.veilo.network/rewards/seasons): Timed seasons, the public leaderboard, what it shows and what it deliberately does not.
- [Rewards: Referrals](https://docs.veilo.network/rewards/referrals): Your referral code, the fee share it earns, and how invites are tracked.
- [Privacy & trust: Privacy guarantees](https://docs.veilo.network/privacy/guarantees): What Veilo protects, and the mechanism behind each guarantee.
- [Privacy & trust: What Veilo does not claim](https://docs.veilo.network/privacy/limits): What stays visible, what Veilo cannot hide, and why.
- [Privacy & trust: Trust model](https://docs.veilo.network/privacy/trust-model): Custody, administrative power, and what happens to your funds if Veilo disappears.
- [Privacy & trust: Best practices](https://docs.veilo.network/privacy/best-practices): How to use the pool so that your own habits do not undo its privacy.
- [Developers: Build on Veilo](https://docs.veilo.network/developers): What Veilo exposes as infrastructure, and the SDK that is coming.

## Cloak API

- [Getting started: Cloak API](https://docs.veilo.network/cloak): Build private withdrawals, merchant checkout, and payroll or contractor payments.
- [Getting started: Becoming a partner](https://docs.veilo.network/cloak/partners): Create a portal account, complete onboarding, and configure credentials and fee wallets.
- [Getting started: Quickstart](https://docs.veilo.network/cloak/quickstart): The whole integration end to end: quote, create, sign, poll, in five languages.
- [Getting started: Authentication](https://docs.veilo.network/cloak/authentication): Bearer keys, how rotation works, and why every auth failure looks alike.
- [Core concepts: Amounts & assets](https://docs.veilo.network/cloak/amounts): Raw base units as strings, asset IDs, and the difference between exact_in and exact_out.
- [Core concepts: How fees are built](https://docs.veilo.network/cloak/fees): The three fee components, a reconciled example, and why the latest quote is authoritative.
- [Core concepts: Your revenue share](https://docs.veilo.network/cloak/revenue): Set feeBps, nominate a wallet, and your share is paid inline in the payout transaction.
- [Endpoints: GET List supported tokens](https://docs.veilo.network/cloak/endpoints/tokens): The authoritative asset catalogue and its live per-asset limits.
- [Endpoints: POST Get a quote](https://docs.veilo.network/cloak/endpoints/quote): Calculate transfer amounts, fees, limits, and estimated delivery time.
- [Endpoints: POST Create an order](https://docs.veilo.network/cloak/endpoints/order): Returns the unsigned v0 transaction your user signs. The only signature.
- [Endpoints: GET Refresh a transaction](https://docs.veilo.network/cloak/endpoints/refresh): Rebuild with a fresh blockhash when the user took too long to sign.
- [Endpoints: GET Poll order status](https://docs.veilo.network/cloak/endpoints/status): Check an order every few seconds and stop when it is final.
- [Endpoints: POST Deposit callback](https://docs.veilo.network/cloak/endpoints/deposit): Optionally report a confirmed deposit so processing can begin sooner.
- [Reference: Signing the transaction](https://docs.veilo.network/cloak/signing): How to sign and submit the versioned transaction returned by Cloak.
- [Reference: Order lifecycle](https://docs.veilo.network/cloak/lifecycle): The eight order states, the four final outcomes, and how to use detailedStatus.
- [Reference: Refunds](https://docs.veilo.network/cloak/refunds): What the sender gets back when a payout fails, which asset it arrives in, and the one cost that is not returned.
- [Reference: Errors](https://docs.veilo.network/cloak/errors): Stable error codes, what each one means, and which are worth retrying.
- [Reference: Limits & rate limits](https://docs.veilo.network/cloak/limits): Per-account budgets, separate buckets for reads and orders, and the RateLimit headers.
- [Reference: Idempotency & retries](https://docs.veilo.network/cloak/idempotency): Which calls are safe to retry, and how to make order creation safe too.
- [Reference: Private swap](https://docs.veilo.network/cloak/swap): Deliver a different asset than was deposited: supported pairs, slippage, destination-asset fees and refunds.
- [Reference: Privacy model](https://docs.veilo.network/cloak/privacy): What Cloak protects, what stays public, and how you may describe it to your users.
- [Reference: Production behavior](https://docs.veilo.network/cloak/design-notes): Production behavior for signing, refresh, status polling, delivery time, and privacy.
