# Sure Docs (draft) ## Docs - [Introduction](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/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://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/quickstart.md): Get started with Sure in minutes - [Complete guide](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/guide.md): Learn how to use Sure to manage your finances - [Self-hosting with Docker](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/self-hosting.md): Deploy Sure on your own infrastructure using Docker Compose - [Self-hosting with Helm](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/self-hosting-helm.md): Deploy Sure on Kubernetes using the official Helm chart - [All Account Types Sure Offers](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/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://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/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://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/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://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/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://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/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. - [AI assistant sidebar](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/guides/app-features/assistant-sidebar.md): Show, hide, and understand the desktop AI sidebar in Sure - [Transactions](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/guides/app-features/transactions.md): Review, categorize, and clean up transactions in Sure - [Budgets](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/guides/app-features/budgets.md): Track your spending with monthly budgets and stay on top of your finances. - [CSV imports](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/guides/app-features/csv-imports.md): Import your financial data from CSV files into Sure - [Statement Vault](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/guides/app-features/statement-vault.md): Store account statements and understand how Sure suggests matching accounts for uploaded PDFs - [Recurring transactions](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/features/recurring-transactions.md): Automatically detect and track recurring transactions like subscriptions, payments, and bills - [Family Sharing](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/guides/app-features/family-sharing.md): Share accounts and collaborate on finances with family members - [Settings](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/guides/app-features/settings.md): Configure Sure to match your preferences and needs - [LLM support](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/llm-support.md): Configure AI features with local or cloud models - [Model Context Protocol (MCP)](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/development/mcp.md): Connect an MCP-compatible AI assistant to your Sure financial data - [Evaluation framework](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/evals.md): Test and compare different LLMs for your use case - [Rails provider generator](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/development/rails-provider-generator.md): Generate new provider integrations with global or per-family credentials - [LLM Benchmarks](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/development/llm-benchmarks.md): Benchmark results of popular foundation and open-weights LLMs with Sure - [Authentication quickstart](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/authentication/quickstart.md): Get started with SSO authentication in 5 minutes - [Authentication guide](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/authentication/guide.md): Complete reference for configuring SSO authentication with OIDC, OAuth2, and SAML - [User management](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/authentication/user-management.md): Manage users, connected accounts, and SSO authentication settings - [Overview](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/providers/overview.md): Choose the right providers for banking, crypto, and market data - [Market data providers](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/providers/market-data.md): Configure securities pricing providers for stock, ETF, and mutual fund data - [Binance](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/providers/binance.md): Connect your Binance account to track cryptocurrency holdings, balances, and trades - [Enable Banking](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/providers/enable-banking.md): Connect European bank accounts using PSD2 open banking - [Lunch Flow](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/providers/lunchflow.md): Connect bank accounts worldwide with global coverage - [Wise](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/providers/wise.md): Connect your Wise multi-currency account using a personal API token - [SimpleFIN](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/providers/simplefin.md): Connect US bank accounts with a cost-effective provider - [Plaid](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/providers/plaid.md): Connect US bank accounts with advanced technical setup - [Redbark](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/providers/redbark.md): Connect Australian bank accounts via CDR open banking - [SnapTrade](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/providers/snaptrade.md): Connect brokerage accounts through the SnapTrade aggregation network - [Coinbase](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/providers/coinbase.md): Connect your Coinbase account to track cryptocurrency holdings and transactions - [CoinStats](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/providers/coinstats.md): Sync cryptocurrency wallets, DeFi positions, and exchange accounts using CoinStats - [Sophtron](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/providers/sophtron.md): Connect US and Canadian bank accounts via Sophtron's aggregation API - [Troubleshooting](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/guides/knowledge-base/troubleshooting.md) - [FAQ](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/guides/knowledge-base/faq.md) - [Sign up a new user](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/auth/sign-up-a-new-user.md) - [Log in with email and password](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/auth/log-in-with-email-and-password.md) - [Exchange mobile SSO authorization code for tokens](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/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://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/auth/refresh-an-access-token.md) - [Link an existing account via SSO](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/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://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/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. - [Enable AI features for the authenticated user](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/auth/enable-ai-features-for-the-authenticated-user.md) - [List accounts](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/accounts/list-accounts.md) - [Retrieve an account](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/accounts/retrieve-an-account.md) - [Show balance sheet](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/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. - [List balance history records](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/balances/list-balance-history-records.md) - [Retrieve a balance history record](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/balances/retrieve-a-balance-history-record.md) - [List budget categories](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/budget-categories/list-budget-categories.md) - [Retrieve a budget category](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/budget-categories/retrieve-a-budget-category.md) - [List budgets](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/budgets/list-budgets.md) - [Retrieve a budget](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/budgets/retrieve-a-budget.md) - [List categories](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/categories/list-categories.md) - [Create category](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/categories/create-category.md) - [Retrieve a category](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/categories/retrieve-a-category.md) - [List chats](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/chats/list-chats.md) - [Create chat](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/chats/create-chat.md) - [Retrieve a chat](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/chats/retrieve-a-chat.md) - [Update a chat](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/chats/update-a-chat.md) - [Delete a chat](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/chats/delete-a-chat.md) - [Create a message](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/chat-messages/create-a-message.md) - [Retry the last assistant response](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/chat-messages/retry-the-last-assistant-response.md) - [Lists family exports](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/family-exports/lists-family-exports.md) - [Queues a family export](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/family-exports/queues-a-family-export.md) - [Shows a family export](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/family-exports/shows-a-family-export.md) - [Downloads a completed family export](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/family-exports/downloads-a-completed-family-export.md) - [Retrieve family settings](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/family-settings/retrieve-family-settings.md): Retrieve a read-only snapshot of non-secret family configuration. - [List holdings](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/holdings/list-holdings.md) - [Retrieve holding](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/holdings/retrieve-holding.md) - [Create import session](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/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://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/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://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/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://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/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://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/imports/list-imports.md): List all imports for the user's family with pagination and filtering. - [Create import](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/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://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/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://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/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://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/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://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/merchants/list-merchants.md) - [Retrieve a merchant](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/merchants/retrieve-a-merchant.md) - [Lists provider connection status summaries](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/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://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/recurring-transactions/list-recurring-transactions.md) - [Create recurring transaction](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/recurring-transactions/create-recurring-transaction.md) - [Retrieve recurring transaction](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/recurring-transactions/retrieve-recurring-transaction.md) - [Update recurring transaction](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/recurring-transactions/update-recurring-transaction.md) - [Delete recurring transaction](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/recurring-transactions/delete-recurring-transaction.md) - [List rejected transfers](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/rejected-transfers/list-rejected-transfers.md) - [Retrieve a rejected transfer](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/rejected-transfers/retrieve-a-rejected-transfer.md) - [List rule runs](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/rule-runs/list-rule-runs.md): List rule run history for the authenticated user family. - [Retrieve a rule run](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/rule-runs/retrieve-a-rule-run.md): Retrieve one rule run from the authenticated user family. - [List rules](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/rules/list-rules.md) - [Retrieve a rule](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/rules/retrieve-a-rule.md) - [List securities referenced by family investment data](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/securities/list-securities-referenced-by-family-investment-data.md) - [Retrieve a security referenced by family investment data](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/securities/retrieve-a-security-referenced-by-family-investment-data.md) - [List security price history referenced by family investment data](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/security-prices/list-security-price-history-referenced-by-family-investment-data.md) - [Retrieve a security price referenced by family investment data](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/security-prices/retrieve-a-security-price-referenced-by-family-investment-data.md) - [Lists sync history](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/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://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/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://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/syncs/shows-a-sync.md): Return sanitized status metadata for a single family-scoped sync. - [List tags](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/tags/list-tags.md) - [Create tag](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/tags/create-tag.md) - [Retrieve a tag](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/tags/retrieve-a-tag.md) - [Update a tag](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/tags/update-a-tag.md) - [Delete a tag](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/tags/delete-a-tag.md) - [List trades](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/trades/list-trades.md) - [Create trade](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/trades/create-trade.md) - [Retrieve trade](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/trades/retrieve-trade.md) - [Update trade](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/trades/update-trade.md) - [Delete trade](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/trades/delete-trade.md) - [List transactions](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/transactions/list-transactions.md): Returns global ledger history for accessible accounts, including disabled accounts but excluding accounts pending deletion. - [Create transaction](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/transactions/create-transaction.md) - [Retrieve a transaction](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/transactions/retrieve-a-transaction.md) - [Update a transaction](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/transactions/update-a-transaction.md) - [Delete a transaction](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/transactions/delete-a-transaction.md) - [List transfers](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/transfers/list-transfers.md) - [Retrieve a transfer](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/transfers/retrieve-a-transfer.md) - [List valuations](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/valuations/list-valuations.md) - [Create valuation](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/valuations/create-valuation.md) - [Retrieve a valuation](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/valuations/retrieve-a-valuation.md) - [Update a valuation](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/valuations/update-a-valuation.md) - [Reset account](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/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://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/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://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/api-reference/users/delete-account.md): Permanently deactivates the current user account and all associated data. This action cannot be undone. ## OpenAPI Specs - [openapi](https://sure-917046f5-mintlify-docs-update-1787370944576.mintlify.site/openapi.yaml)