# Sure Docs (draft)

- [Introduction](https://docs.sure.am/index.md): Sure is a personal finance app for everyone - track your accounts, transactions, and build wealth with complete control over your data
- [Quickstart](https://docs.sure.am/quickstart.md): Get started with Sure in minutes
- [Complete guide](https://docs.sure.am/guide.md): Learn how to use Sure to manage your finances
- [Self-hosting with Docker](https://docs.sure.am/self-hosting.md): Deploy Sure on your own infrastructure using Docker Compose
- [Self-hosting with Render](https://docs.sure.am/self-hosting-render.md): Deploy Sure on Render using one-click deploy templates
- [Self-hosting with Hostim.dev](https://docs.sure.am/self-hosting-hostim.md): Deploy Sure on Hostim.dev with a managed database, Redis, persistent storage, and automatic HTTPS
- [Self-hosting with Helm](https://docs.sure.am/self-hosting-helm.md): Deploy Sure on Kubernetes using the official Helm chart
- [Roadmap](https://docs.sure.am/roadmap.md): What Sure is working on now, planning next, and exploring for the future
- [All Account Types Sure Offers](https://docs.sure.am/guides/key-concepts/account-types.md): A complete reference of all account types available in Sure, including assets, liabilities, and their subtypes organized by region.
- [How Asset Accounts Work](https://docs.sure.am/guides/key-concepts/untitled-page.md): Learn how asset accounts track things you own, how transactions affect balances, and the different types of asset accounts available in Sure.
- [How Debt Accounts Work](https://docs.sure.am/guides/key-concepts/debt-accounts.md): Understand how liability accounts track what you owe, why debt math seems backwards, and how different debt types work in Sure.
- [Managing Investment Accounts](https://docs.sure.am/guides/key-concepts/investment-accounts.md): Learn how to track holdings, trades, cost basis, and investment activity in Sure's investment and crypto accounts.
- [Transfers Between Accounts](https://docs.sure.am/guides/key-concepts/transfers.md): Learn how transfers work in Sure, including transfer types, automatic matching, and how transfers affect your budgets and net worth.
- [Sure clients](https://docs.sure.am/guides/key-concepts/clients.md): Choose the right client for accessing Sure — web, desktop, mobile, MCP, or API.
- [AI assistant sidebar](https://docs.sure.am/guides/app-features/assistant-sidebar.md): Show, hide, and understand the desktop AI sidebar in Sure
- [Transactions](https://docs.sure.am/guides/app-features/transactions.md): Review, categorize, and clean up transactions in Sure
- [Budgets](https://docs.sure.am/guides/app-features/budgets.md): Track your spending with monthly budgets and stay on top of your finances.
- [CSV imports](https://docs.sure.am/guides/app-features/csv-imports.md): Import your financial data from CSV files into Sure
- [Statement Vault](https://docs.sure.am/guides/app-features/statement-vault.md): Store account statements and understand how Sure suggests matching accounts for uploaded PDFs
- [Recurring transactions](https://docs.sure.am/features/recurring-transactions.md): Automatically detect and track recurring transactions like subscriptions, payments, and bills
- [Goals](https://docs.sure.am/guides/app-features/goals.md): Set savings goals and emergency fund reserves, track progress, and record pledges in Sure
- [Insights](https://docs.sure.am/guides/app-features/insights.md): Proactive, AI-written financial observations delivered to your family nightly
- [Family Sharing](https://docs.sure.am/guides/app-features/family-sharing.md): Share accounts and collaborate on finances with family members
- [Settings](https://docs.sure.am/guides/app-features/settings.md): Configure Sure to match your preferences and needs
- [Passkeys and security keys](https://docs.sure.am/guides/app-features/passkeys.md): Use passkeys, Touch ID, Windows Hello, or hardware security keys to sign in or verify MFA
- [API keys](https://docs.sure.am/guides/app-features/api-keys.md): Create and manage API keys for programmatic access to your Sure data
- [LLM support](https://docs.sure.am/llm-support.md): Configure AI features with local or cloud models
- [Model Context Protocol (MCP)](https://docs.sure.am/development/mcp.md): Connect an MCP-compatible AI assistant to your Sure financial data
- [Evaluation framework](https://docs.sure.am/evals.md): Test and compare different LLMs for your use case
- [Rails provider generator](https://docs.sure.am/development/rails-provider-generator.md): Generate new provider integrations with global or per-family credentials
- [LLM Benchmarks](https://docs.sure.am/development/llm-benchmarks.md): Benchmark results of popular foundation and open-weights LLMs with Sure
- [Authentication quickstart](https://docs.sure.am/authentication/quickstart.md): Get started with SSO authentication in 5 minutes
- [Authentication guide](https://docs.sure.am/authentication/guide.md): Complete reference for configuring SSO authentication with OIDC, OAuth2, and SAML
- [User management](https://docs.sure.am/authentication/user-management.md): Manage users, families, roles, and authentication settings from the admin panel
- [Overview](https://docs.sure.am/providers/overview.md): Choose the right providers for banking, crypto, and market data
- [Transaction history and import limits](https://docs.sure.am/providers/transaction-history.md): How far back Sure requests transactions, what can limit the results, and how to fill gaps
- [Market data providers](https://docs.sure.am/providers/market-data.md): Configure securities pricing providers for stock, ETF, and mutual fund data
- [Mansa API](https://docs.sure.am/providers/mansa.md): Connect NGX (Nigerian Exchange) securities with the Mansa API provider
- [Property valuations](https://docs.sure.am/providers/property-valuations.md): Automatically look up and refresh property values using RentCast or Realie
- [Apple Wallet](https://docs.sure.am/providers/apple-wallet.md): Connect Apple Card and Apple Cash accounts via FinanceKit on iOS
- [On-chain wallets](https://docs.sure.am/providers/onchain-wallets.md): Track self-custody Bitcoin, EVM, and Solana wallets by public address — no keys required.
- [Akahu](https://docs.sure.am/providers/akahu.md): Connect New Zealand bank accounts to Sure via Akahu
- [Binance](https://docs.sure.am/providers/binance.md): Connect your Binance account to track cryptocurrency holdings, balances, and trades
- [Brex](https://docs.sure.am/providers/brex.md): Connect Brex business cash and card accounts to Sure
- [Coinbase](https://docs.sure.am/providers/coinbase.md): Connect your Coinbase account to track cryptocurrency holdings and transactions
- [CoinSpot](https://docs.sure.am/providers/coinspot.md): Connect your CoinSpot account to track cryptocurrency holdings, balances, and trades
- [CoinStats](https://docs.sure.am/providers/coinstats.md): Sync cryptocurrency wallets, DeFi positions, and exchange accounts using CoinStats
- [Enable Banking](https://docs.sure.am/providers/enable-banking.md): Connect European bank accounts using PSD2 open banking
- [Fio banka](https://docs.sure.am/providers/fio.md): Connect your Fio banka (Czechia) account to Sure
- [Indexa Capital](https://docs.sure.am/providers/indexa-capital.md): Connect Indexa Capital automated investment portfolios to Sure
- [Interactive Brokers](https://docs.sure.am/providers/interactive-brokers.md): Connect Interactive Brokers investment accounts to Sure using Flex Web Service reports
- [Kraken](https://docs.sure.am/providers/kraken.md): Connect Kraken crypto exchange accounts to Sure
- [Lunch Flow](https://docs.sure.am/providers/lunchflow.md): Connect bank accounts worldwide with global coverage
- [Mercury](https://docs.sure.am/providers/mercury.md): Connect Mercury business bank accounts to Sure
- [Monobank](https://docs.sure.am/providers/monobank.md): Connect your Monobank (Ukraine) account to Sure
- [Questrade](https://docs.sure.am/providers/questrade.md): Connect your Questrade investment accounts to Sure
- [Wise](https://docs.sure.am/providers/wise.md): Connect your Wise multi-currency account using a personal API token
- [SimpleFIN](https://docs.sure.am/providers/simplefin.md): Connect US bank accounts with a cost-effective provider
- [Plaid](https://docs.sure.am/providers/plaid.md): Connect US bank accounts with advanced technical setup
- [Redbark](https://docs.sure.am/providers/redbark.md): Connect Australian bank accounts via CDR open banking
- [Up bank](https://docs.sure.am/providers/up-bank.md): Connect your Up bank account to Sure
- [SnapTrade](https://docs.sure.am/providers/snaptrade.md): Connect brokerage accounts through the SnapTrade aggregation network
- [Sophtron](https://docs.sure.am/providers/sophtron.md): Connect US and Canadian bank accounts via Sophtron's aggregation API
- [Trade Republic](https://docs.sure.am/providers/trade-republic.md): Connect a Trade Republic investment account via secure web login
- [Trading 212](https://docs.sure.am/providers/trading212.md): Connect a Trading 212 investment account via API key
- [FinanceKit](https://docs.sure.am/providers/financekit.md): Sync Apple Wallet data directly from iOS devices
- [Jev (TypeSafe)](https://docs.sure.am/providers/jev.md): Use Jev for transaction categorization with calibrated confidence scores
- [Troubleshooting](https://docs.sure.am/guides/knowledge-base/troubleshooting.md)
- [FAQ](https://docs.sure.am/guides/knowledge-base/faq.md)
- [Sign up a new user](https://docs.sure.am/api-reference/auth/sign-up-a-new-user.md): Creates a new user and family. The first user on a fresh instance is assigned the super_admin role; later family creators are assigned an admin role.
- [Log in with email and password](https://docs.sure.am/api-reference/auth/log-in-with-email-and-password.md)
- [Exchange mobile SSO authorization code for tokens](https://docs.sure.am/api-reference/auth/exchange-mobile-sso-authorization-code-for-tokens.md): Exchanges a one-time authorization code (received via deep link after mobile SSO) for OAuth tokens. The code is single-use and expires after 5 minutes.
- [Refresh an access token](https://docs.sure.am/api-reference/auth/refresh-an-access-token.md)
- [Link an existing account via SSO](https://docs.sure.am/api-reference/auth/link-an-existing-account-via-sso.md): Authenticates with email/password and links the SSO identity from a previously issued linking code. Creates an OidcIdentity, logs the link via SsoAuditLog, and issues mobile OAuth tokens.
- [Create a new account via SSO](https://docs.sure.am/api-reference/auth/create-a-new-account-via-sso.md): Creates a new user and family from a previously issued linking code. Links the SSO identity via OidcIdentity, logs the JIT account creation via SsoAuditLog, and issues mobile OAuth tokens. The linking code must have allow_account_creation enabled. The first user on a fresh instance is assigned the s…
- [Enable AI features for the authenticated user](https://docs.sure.am/api-reference/auth/enable-ai-features-for-the-authenticated-user.md)
- [List accounts](https://docs.sure.am/api-reference/accounts/list-accounts.md)
- [Retrieve an account](https://docs.sure.am/api-reference/accounts/retrieve-an-account.md)
- [Show balance sheet](https://docs.sure.am/api-reference/balance-sheet/show-balance-sheet.md): Returns the family balance sheet including net worth, total assets, and total liabilities with amounts converted to the family's primary currency.
- [Show cash flow and optional Sankey graph](https://docs.sure.am/api-reference/cash-flow/show-cash-flow-and-optional-sankey-graph.md): Server-calculated income, spending, savings, and daily cumulative comparison in family currency. Uses the authenticated user’s finance accounts and Sure reporting rules. Browser sessions do not authenticate this public API.
- [List balance history records](https://docs.sure.am/api-reference/balances/list-balance-history-records.md)
- [Retrieve a balance history record](https://docs.sure.am/api-reference/balances/retrieve-a-balance-history-record.md)
- [List budget categories](https://docs.sure.am/api-reference/budget-categories/list-budget-categories.md)
- [Retrieve a budget category](https://docs.sure.am/api-reference/budget-categories/retrieve-a-budget-category.md)
- [List budgets](https://docs.sure.am/api-reference/budgets/list-budgets.md)
- [Retrieve a budget](https://docs.sure.am/api-reference/budgets/retrieve-a-budget.md)
- [List categories](https://docs.sure.am/api-reference/categories/list-categories.md)
- [Create category](https://docs.sure.am/api-reference/categories/create-category.md)
- [Retrieve a category](https://docs.sure.am/api-reference/categories/retrieve-a-category.md)
- [List chats](https://docs.sure.am/api-reference/chats/list-chats.md)
- [Create chat](https://docs.sure.am/api-reference/chats/create-chat.md)
- [Retrieve a chat](https://docs.sure.am/api-reference/chats/retrieve-a-chat.md)
- [Update a chat](https://docs.sure.am/api-reference/chats/update-a-chat.md)
- [Delete a chat](https://docs.sure.am/api-reference/chats/delete-a-chat.md)
- [Create a message](https://docs.sure.am/api-reference/chat-messages/create-a-message.md)
- [Retry the last assistant response](https://docs.sure.am/api-reference/chat-messages/retry-the-last-assistant-response.md)
- [Lists family exports](https://docs.sure.am/api-reference/family-exports/lists-family-exports.md)
- [Queues a family export](https://docs.sure.am/api-reference/family-exports/queues-a-family-export.md)
- [Shows a family export](https://docs.sure.am/api-reference/family-exports/shows-a-family-export.md)
- [Downloads a completed family export](https://docs.sure.am/api-reference/family-exports/downloads-a-completed-family-export.md)
- [Retrieve family settings](https://docs.sure.am/api-reference/family-settings/retrieve-family-settings.md): Retrieve a read-only snapshot of non-secret family configuration.
- [List holdings](https://docs.sure.am/api-reference/holdings/list-holdings.md)
- [Retrieve holding](https://docs.sure.am/api-reference/holdings/retrieve-holding.md)
- [Create import session](https://docs.sure.am/api-reference/import-sessions/create-import-session.md): Create or idempotently retrieve a multi-file SureImport session keyed by client_session_id.
- [Retrieve import session](https://docs.sure.am/api-reference/import-sessions/retrieve-import-session.md): Retrieve import session status, chunk status, per-entity summary counts, and safe error details.
- [Upload import session chunk](https://docs.sure.am/api-reference/import-sessions/upload-import-session-chunk.md): Attach an ordered Sure NDJSON chunk to an import session. Chunks are idempotent by sequence and client_chunk_id with content verification.
- [Publish import session](https://docs.sure.am/api-reference/import-sessions/publish-import-session.md): Queue ordered chunk processing for a SureImport session. Later chunks can reference source IDs mapped by earlier chunks.
- [List imports](https://docs.sure.am/api-reference/imports/list-imports.md): List all imports for the user's family with pagination and filtering.
- [Create import](https://docs.sure.am/api-reference/imports/create-import.md): Create a new import from raw CSV content, inline Sure NDJSON content, or an uploaded Sure NDJSON file. CSV content is limited to 10MB.
- [Retrieve an import](https://docs.sure.am/api-reference/imports/retrieve-an-import.md): Retrieve detailed information about a specific import, including configuration, row statistics, and SureImport readback verification when available.
- [List import row diagnostics](https://docs.sure.am/api-reference/imports/list-import-row-diagnostics.md): List sanitized import rows with validation errors and mapping resolution state.
- [Validate import content without creating an import](https://docs.sure.am/api-reference/imports/validate-import-content-without-creating-an-import.md): Validate CSV or Sure NDJSON import content and return counts, headers, warnings, and validation errors without persisting an import or enqueueing jobs. CSV content is limited to 10MB.
- [List merchants](https://docs.sure.am/api-reference/merchants/list-merchants.md)
- [Import merchants from CSV](https://docs.sure.am/api-reference/merchants/import-merchants-from-csv.md)
- [Retrieve a merchant](https://docs.sure.am/api-reference/merchants/retrieve-a-merchant.md)
- [Lists provider connection status summaries](https://docs.sure.am/api-reference/provider-connections/lists-provider-connection-status-summaries.md): List safe provider connection status metadata for the authenticated user's family without exposing credentials, raw provider payloads, or raw sync errors.
- [List recurring transactions](https://docs.sure.am/api-reference/recurring-transactions/list-recurring-transactions.md)
- [Create recurring transaction](https://docs.sure.am/api-reference/recurring-transactions/create-recurring-transaction.md)
- [Retrieve recurring transaction](https://docs.sure.am/api-reference/recurring-transactions/retrieve-recurring-transaction.md)
- [Update recurring transaction](https://docs.sure.am/api-reference/recurring-transactions/update-recurring-transaction.md)
- [Delete recurring transaction](https://docs.sure.am/api-reference/recurring-transactions/delete-recurring-transaction.md)
- [List rejected transfers](https://docs.sure.am/api-reference/rejected-transfers/list-rejected-transfers.md)
- [Retrieve a rejected transfer](https://docs.sure.am/api-reference/rejected-transfers/retrieve-a-rejected-transfer.md)
- [List rule runs](https://docs.sure.am/api-reference/rule-runs/list-rule-runs.md): List rule run history for the authenticated user family.
- [Retrieve a rule run](https://docs.sure.am/api-reference/rule-runs/retrieve-a-rule-run.md): Retrieve one rule run from the authenticated user family.
- [List rules](https://docs.sure.am/api-reference/rules/list-rules.md)
- [Retrieve a rule](https://docs.sure.am/api-reference/rules/retrieve-a-rule.md)
- [List securities referenced by family investment data](https://docs.sure.am/api-reference/securities/list-securities-referenced-by-family-investment-data.md)
- [Retrieve a security referenced by family investment data](https://docs.sure.am/api-reference/securities/retrieve-a-security-referenced-by-family-investment-data.md)
- [List security price history referenced by family investment data](https://docs.sure.am/api-reference/security-prices/list-security-price-history-referenced-by-family-investment-data.md)
- [Retrieve a security price referenced by family investment data](https://docs.sure.am/api-reference/security-prices/retrieve-a-security-price-referenced-by-family-investment-data.md)
- [Lists sync history](https://docs.sure.am/api-reference/syncs/lists-sync-history.md): List sanitized sync status history for the authenticated user's family, accounts, and provider connections.
- [Shows the latest sync](https://docs.sure.am/api-reference/syncs/shows-the-latest-sync.md): Return the most recently created sanitized sync status for the authenticated user's family, or data: null when no sync exists.
- [Shows a sync](https://docs.sure.am/api-reference/syncs/shows-a-sync.md): Return sanitized status metadata for a single family-scoped sync.
- [List tags](https://docs.sure.am/api-reference/tags/list-tags.md)
- [Create tag](https://docs.sure.am/api-reference/tags/create-tag.md)
- [Retrieve a tag](https://docs.sure.am/api-reference/tags/retrieve-a-tag.md)
- [Update a tag](https://docs.sure.am/api-reference/tags/update-a-tag.md)
- [Delete a tag](https://docs.sure.am/api-reference/tags/delete-a-tag.md)
- [List trades](https://docs.sure.am/api-reference/trades/list-trades.md)
- [Create trade](https://docs.sure.am/api-reference/trades/create-trade.md)
- [Retrieve trade](https://docs.sure.am/api-reference/trades/retrieve-trade.md)
- [Update trade](https://docs.sure.am/api-reference/trades/update-trade.md)
- [Delete trade](https://docs.sure.am/api-reference/trades/delete-trade.md)
- [List transactions](https://docs.sure.am/api-reference/transactions/list-transactions.md): Returns global ledger history for accessible accounts, including disabled accounts but excluding accounts pending deletion.
- [Create transaction](https://docs.sure.am/api-reference/transactions/create-transaction.md)
- [Retrieve a transaction](https://docs.sure.am/api-reference/transactions/retrieve-a-transaction.md)
- [Update a transaction](https://docs.sure.am/api-reference/transactions/update-a-transaction.md)
- [Delete a transaction](https://docs.sure.am/api-reference/transactions/delete-a-transaction.md)
- [List transfers](https://docs.sure.am/api-reference/transfers/list-transfers.md)
- [Retrieve a transfer](https://docs.sure.am/api-reference/transfers/retrieve-a-transfer.md)
- [List valuations](https://docs.sure.am/api-reference/valuations/list-valuations.md)
- [Create valuation](https://docs.sure.am/api-reference/valuations/create-valuation.md)
- [Retrieve a valuation](https://docs.sure.am/api-reference/valuations/retrieve-a-valuation.md)
- [Update a valuation](https://docs.sure.am/api-reference/valuations/update-a-valuation.md)
- [List proactive insights](https://docs.sure.am/api-reference/insights/list-proactive-insights.md)
- [Register an APNs device token](https://docs.sure.am/api-reference/push-subscriptions/register-an-apns-device-token.md): Available only in hosted (managed) mode. Requires write scope.
- [Unregister an APNs device token](https://docs.sure.am/api-reference/push-subscriptions/unregister-an-apns-device-token.md): Available only in hosted (managed) mode. Requires write scope.
- [Reset account](https://docs.sure.am/api-reference/users/reset-account.md): Resets all financial data (accounts, categories, merchants, tags, etc.) for the current user's family while keeping the user account intact. The reset runs asynchronously in the background. The returned job_id is informational only; reset status is family-scoped, not job-scoped. Requires admin role.
- [Retrieve reset status](https://docs.sure.am/api-reference/users/retrieve-reset-status.md): Returns counts of family-owned data targeted by account reset. Use this after DELETE /api/v1/users/reset to decide whether reset materialization has completed. Completion is a counts-based family snapshot and may change if new data is created after reset.
- [Delete account](https://docs.sure.am/api-reference/users/delete-account.md): Permanently deactivates the current user account and all associated data. This action cannot be undone.
- [Discover FinanceKit background publisher support](https://docs.sure.am/api-reference/financekit/discover-financekit-background-publisher-support.md)
- [Enroll a FinanceKit device publisher](https://docs.sure.am/api-reference/financekit/enroll-a-financekit-device-publisher.md)
- [Read publisher health and paginated mappings](https://docs.sure.am/api-reference/financekit/read-publisher-health-and-paginated-mappings.md)
- [Revoke a publisher, retaining or discarding imported financial history](https://docs.sure.am/api-reference/financekit/revoke-a-publisher-retaining-or-discarding-imported-financial-history.md)
- [Explicitly create or link a canonical account lineage](https://docs.sure.am/api-reference/financekit/explicitly-create-or-link-a-canonical-account-lineage.md)
- [Activate the background publisher](https://docs.sure.am/api-reference/financekit/activate-the-background-publisher.md)
- [Credential the background publisher](https://docs.sure.am/api-reference/financekit/credential-the-background-publisher.md)
- [Repair the background publisher](https://docs.sure.am/api-reference/financekit/repair-the-background-publisher.md)
- [Durably accept an ordered FinanceKit publisher batch](https://docs.sure.am/api-reference/financekit/durably-accept-an-ordered-financekit-publisher-batch.md)
- [Read the durable receipt for an accepted batch](https://docs.sure.am/api-reference/financekit/read-the-durable-receipt-for-an-accepted-batch.md): Recover an accepted batch receipt, including its current processing status.
- [List conflicts requiring user review](https://docs.sure.am/api-reference/financekit/list-conflicts-requiring-user-review.md)
- [Resolve a FinanceKit import conflict](https://docs.sure.am/api-reference/financekit/resolve-a-financekit-import-conflict.md)

## OpenAPI Specs

- [openapi](/openapi.yaml)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.