# Docs

## Docs

- [Get Merchant Accounts](https://docs.knotapi.com/api-reference/accounts/get-accounts.md): Get a user's merchant accounts linked to Knot.
- [Unlink Merchant Account](https://docs.knotapi.com/api-reference/accounts/unlink-account.md): Unlink a merchant account from the Knot platform.
- [Get Audit Logs](https://docs.knotapi.com/api-reference/audit-logs/get-audit-logs.md): Retrieve audit logs for employee usage of the Knot Dashboard.
- [Authenticate Knot API requests with HTTP basic auth](https://docs.knotapi.com/api-reference/authentication.md): Authenticate Knot API requests using HTTP basic auth with your client_id and secret, base64-encoded, plus the development and production base URLs.
- [Link Account](https://docs.knotapi.com/api-reference/development/link-account.md): Link a merchant account in development.
- [mTLS](https://docs.knotapi.com/api-reference/mTLS.md): Configure mutual TLS (mTLS) authentication for enhanced API security using client certificates.
- [List Merchants](https://docs.knotapi.com/api-reference/merchants/list-merchants.md): Retrieve a list of available merchants.
- [Retrieve JWK](https://docs.knotapi.com/api-reference/products/card-switcher/retrieve-jwk.md): Retrieve a public key in JWK format.
- [Switch Card](https://docs.knotapi.com/api-reference/products/card-switcher/switch-card.md): Switch a card in a user's merchant account.
- [Switch Card JWE](https://docs.knotapi.com/api-reference/products/card-switcher/switch-card-jwe.md): Switch a card in a user's merchant account.
- [Detect Accounts](https://docs.knotapi.com/api-reference/products/detect/detect-accounts.md): Detect merchant accounts with a user's email.
- [List Detected Accounts](https://docs.knotapi.com/api-reference/products/detect/list-detected-accounts.md): List a user's detected accounts using cursor-based pagination.
- [Search Detected Accounts](https://docs.knotapi.com/api-reference/products/detect/search-detected-accounts.md): Search for a user's merchant accounts online.
- [Sync Detected Accounts](https://docs.knotapi.com/api-reference/products/detect/sync-detected-accounts.md): Sync a user's detected accounts using cursor-based pagination.
- [Checkout](https://docs.knotapi.com/api-reference/products/shopping/checkout.md): Checkout a user's merchant cart.
- [Sync Cart](https://docs.knotapi.com/api-reference/products/shopping/sync-cart.md): Add one or more products to a user's merchant cart.
- [Cancel Subscription](https://docs.knotapi.com/api-reference/products/subscriptions/cancel.md): Cancel a subscription or bill associated with a linked merchant account.
- [Get Subscription By ID](https://docs.knotapi.com/api-reference/products/subscriptions/get-by-id.md): Get a specific subscription by ID.
- [List Subscriptions](https://docs.knotapi.com/api-reference/products/subscriptions/list.md): List a user's subscriptions using cursor-based pagination.
- [Refresh Subscriptions](https://docs.knotapi.com/api-reference/products/subscriptions/refresh.md): Initiate an on-demand refresh of subscription data for a user's merchant account.
- [The Subscription Object](https://docs.knotapi.com/api-reference/products/subscriptions/subscription-object.md)
- [Get Transaction By ID](https://docs.knotapi.com/api-reference/products/transaction-link/get-by-id.md): Get a specific transaction by ID.
- [Refresh Transactions](https://docs.knotapi.com/api-reference/products/transaction-link/refresh.md): Initiate an on-demand refresh of transaction data for a user's merchant account.
- [Sync Transactions](https://docs.knotapi.com/api-reference/products/transaction-link/sync.md): Sync a user's transactions for a merchant account using cursor-based pagination.
- [The Transaction Object](https://docs.knotapi.com/api-reference/products/transaction-link/transaction-object.md)
- [Create Session](https://docs.knotapi.com/api-reference/sessions/create-session.md): Create a session and use it to initialize the SDK.
- [Extend Session](https://docs.knotapi.com/api-reference/sessions/extend-session.md): Extend a session.
- [Delete User & Data](https://docs.knotapi.com/api-reference/users/delete-user-and-data.md): Delete a user and their data.
- [Versioning](https://docs.knotapi.com/api-reference/versioning.md): Understand how API versioning works and how to specify API versions using the Knot-Version header.
- [Building with AI](https://docs.knotapi.com/building-with-ai.md): Use AI-powered tools to integrate Knot's products faster by searching docs from your IDE with the MCP server or installing skills to guide your agent through specific integrations.
- [Server-Side Updates](https://docs.knotapi.com/card-switcher/card-updater.md): Automatically provision new cards to merchant accounts without user interaction.
- [Personalization](https://docs.knotapi.com/card-switcher/personalization.md): Learn about automatic personalization features in the CardSwitcher experience using detected merchant accounts.
- [Plaid Integration](https://docs.knotapi.com/card-switcher/plaid-integration.md)
- [I2C](https://docs.knotapi.com/card-switcher/processor-digital-banking-integrations/i2c.md): Use Knot's direct integration with I2C to securely retrieve and send card information without backend requests.
- [Q2](https://docs.knotapi.com/card-switcher/processor-digital-banking-integrations/q2.md): Enable cardholders to add their cards to merchants through Knot's direct integration with Q2 mobile banking.
- [Unit](https://docs.knotapi.com/card-switcher/processor-digital-banking-integrations/unit.md): Use Knot's direct integration with Unit to securely retrieve and send card information without backend requests.
- [Quickstart](https://docs.knotapi.com/card-switcher/quickstart.md): Get started with the CardSwitcher integration to provision cards to merchant accounts.
- [Sending Card Data](https://docs.knotapi.com/card-switcher/sending-card-data.md): Learn how to securely send card data to Knot using JWE encryption, vault providers, or processor integrations.
- [Testing](https://docs.knotapi.com/card-switcher/testing.md): Use test credentials and best practices to test CardSwitcher functionality in development and production environments.
- [CARD_FAILED](https://docs.knotapi.com/card-switcher/webhook-events/card-failed.md): Fired when a card failed to be updated in a merchant account.
- [CARD_UPDATED](https://docs.knotapi.com/card-switcher/webhook-events/card-updated.md): Fired when a card is updated in a merchant account.
- [Product Updates](https://docs.knotapi.com/changelog/product-updates.md)
- [SDK version updates](https://docs.knotapi.com/changelog/sdk-updates.md): Release notes for the Knot Link iOS, Android, React Native, Flutter, and Web SDKs, with an RSS feed you can subscribe to for new version alerts.
- [Overview](https://docs.knotapi.com/dashboard/overview.md): Learn about the Knot Dashboard where you can manage API keys, webhooks, and team permissions.
- [Single Sign-On](https://docs.knotapi.com/dashboard/single-sign-on.md): Configure single sign-on (SSO) for your team using SAML 2.0 with identity providers like Okta.
- [Quickstart](https://docs.knotapi.com/detect/quickstart.md)
- [NEW_DETECTED_ACCOUNTS_AVAILABLE](https://docs.knotapi.com/detect/webhook-events/new-detected-accounts-available.md): Fired when new detected accounts are available.
- [Introduction](https://docs.knotapi.com/introduction.md): Overview of Knot's merchant connectivity platform.
- [Launch Checklist](https://docs.knotapi.com/launch-checklist.md): Essential checklist of tasks to complete before launching your Knot integration in production.
- [Retrieving and Listing Merchants](https://docs.knotapi.com/link/retrieving-and-listing-merchants.md): Retrieve and display available merchants in your app's UI using the List Merchants API.
- [ACCOUNT_LOGIN_REQUIRED](https://docs.knotapi.com/link/webhook-events/account-login-required.md): Fired when a user's merchant account is disconnected and requires the user to login again to reconnect the account.
- [AUTHENTICATED](https://docs.knotapi.com/link/webhook-events/authenticated.md): Fired when the authentication to a merchant is successful.
- [CREDENTIALS_FAILED](https://docs.knotapi.com/link/webhook-events/credentials-failed.md): Fired when the login credentials used to login to a merchant are incorrect and the user needs to re-enter them (if a `CARD_FAILED` webhook is not received).
- [DOB_FAILED](https://docs.knotapi.com/link/webhook-events/dob-failed.md): Fired when the date of birth provided is incorrect and the user needs to re-enter it (if a `CARD_FAILED` webhook is not received).
- [DOB_REQUIRED](https://docs.knotapi.com/link/webhook-events/dob-required.md): Fired when a user needs to verify their date of birth to login to a merchant for the 1st time.
- [LICENSE_FAILED](https://docs.knotapi.com/link/webhook-events/license-failed.md): Fired when an incorrect driver license number is provided and the user needs to re-enter the driver license number.
- [LICENSE_REQUIRED](https://docs.knotapi.com/link/webhook-events/license-required.md): Fired when a user needs to provide their driver license number to login to a merchant for the 1st time.
- [LOGIN_APPROVAL](https://docs.knotapi.com/link/webhook-events/login-approval.md): Fired when a user needs to approve the login to a merchant via a push notification, text message, or similar from a merchant.
- [MERCHANT_STATUS_UPDATE](https://docs.knotapi.com/link/webhook-events/merchant-status-update.md): Fired when a merchant becomes available or unavailable.
- [OTP_FAILED](https://docs.knotapi.com/link/webhook-events/otp-failed.md): Fired when the OTP code used to login to a merchant is incorrect and the user needs to re-enter it (if a `CARD_FAILED` webhook is not received).
- [OTP_REQUIRED](https://docs.knotapi.com/link/webhook-events/otp-required.md): Fired when a user needs to enter an OTP code to login to a merchant for the 1st time.
- [QUESTIONS_FAILED](https://docs.knotapi.com/link/webhook-events/questions-failed.md): Fired when the answers to security questions are incorrect and the user needs to re-enter the answers (if a `CARD_FAILED` webhook is not received).
- [QUESTIONS_REQUIRED](https://docs.knotapi.com/link/webhook-events/questions-required.md): Fired when a user needs to provide answers to security questions for the 1st time.
- [Localization](https://docs.knotapi.com/localization.md): Localize the Knot SDK to display content in your users' preferred language.
- [Android SDK](https://docs.knotapi.com/sdk/android.md): Install and initialize the Knot Link Android SDK via Maven Central, configure a session, and handle events to link users' merchant accounts.
- [Flutter SDK](https://docs.knotapi.com/sdk/flutter.md): Add the Knot Link Flutter SDK to your Dart project with pub, initialize a session, and handle events to link users' merchant accounts.
- [Introduction](https://docs.knotapi.com/sdk/introduction.md): Overview of Knot SDKs for iOS, Android, React Native, Flutter, and Web platforms.
- [iOS SDK](https://docs.knotapi.com/sdk/ios.md): Install the Knot Link iOS SDK with CocoaPods or Swift Package Manager, initialize a session, and handle events to link users' merchant accounts.
- [Android Version 2.0+](https://docs.knotapi.com/sdk/migration-guides/android/android-2-0.md)
- [Flutter Version 1.0+](https://docs.knotapi.com/sdk/migration-guides/flutter/flutter-1-0.md)
- [iOS Version 1.0+](https://docs.knotapi.com/sdk/migration-guides/ios/ios-1-0.md)
- [React Native Version 1.0+](https://docs.knotapi.com/sdk/migration-guides/react-native/react-native-1-0.md)
- [Web Version 1.0+](https://docs.knotapi.com/sdk/migration-guides/web/web-1-0.md)
- [React Native SDK](https://docs.knotapi.com/sdk/react-native.md): Install the Knot Link React Native SDK with npm or yarn, initialize a session, and handle events to link users' merchant accounts in your app.
- [Web SDK](https://docs.knotapi.com/sdk/web.md): Load the Knot Link JS SDK from unpkg or npm, initialize a session in the browser, and handle events to link users' merchant accounts on the web.
- [Quickstart](https://docs.knotapi.com/shopping/quickstart.md): Get started with the Shopping integration to enable cart creation and checkout capabilities in your app.
- [Testing](https://docs.knotapi.com/shopping/testing.md): Test the the Shopping flow including linking accounts, syncing carts, and checkout using test credentials in development.
- [CHECKOUT_FAILED](https://docs.knotapi.com/shopping/webhook-events/checkout-failed.md): Triggered when checkout fails for a user's merchant cart.
- [CHECKOUT_SUCCEEDED](https://docs.knotapi.com/shopping/webhook-events/checkout-succeeded.md): Fired when checkout succeeds for a user's merchant cart.
- [SYNC_CART_FAILED](https://docs.knotapi.com/shopping/webhook-events/sync-cart-failed.md): Fired when adding products to a user's merchant cart fails.
- [SYNC_CART_SUCCEEDED](https://docs.knotapi.com/shopping/webhook-events/sync-cart-succeeded.md): Fired when adding products to a user's merchant cart is successful.
- [Quickstart](https://docs.knotapi.com/subscription-manager/quickstart.md): Get started with SubscriptionManager to retrieve and manage subscription data from merchant accounts.
- [CANCELLATION_FAILED](https://docs.knotapi.com/subscription-manager/webhook-events/cancellation-failed.md): Fired when a subscription or bill fails to be canceled.
- [CANCELLATION_SUCCEEDED](https://docs.knotapi.com/subscription-manager/webhook-events/cancellation-succeeded.md): Fired when a subscription or bill is canceled successfully.
- [NEW_SUBSCRIPTIONS_AVAILABLE](https://docs.knotapi.com/subscription-manager/webhook-events/new-subscriptions-available.md): Fired when new subscriptions are available for a user's merchant account.
- [UPDATED_SUBSCRIPTIONS_AVAILABLE](https://docs.knotapi.com/subscription-manager/webhook-events/updated-subscriptions-available.md): Fired when updates are available for existing subscriptions for a user's merchant account.
- [Quickstart](https://docs.knotapi.com/transaction-link/quickstart.md): Get started with the TransactionLink integration to retrieve SKU-level transaction data from merchant accounts.
- [Testing](https://docs.knotapi.com/transaction-link/testing.md): Test TransactionLink functionality including account linking and transaction generation using test credentials in development.
- [NEW_TRANSACTIONS_AVAILABLE](https://docs.knotapi.com/transaction-link/webhook-events/new-transactions-available.md): Fired when new transactions for a user's merchant account are available.
- [UPDATED_TRANSACTIONS_AVAILABLE](https://docs.knotapi.com/transaction-link/webhook-events/updated-transactions-available.md): Fired when updated data is available for existing transactions for a user's merchant account.
- [Cross-Merchant Savings](https://docs.knotapi.com/use-cases/cross-merchant-savings.md): Alert users when a product they bought is available for less at another merchant.
- [Dispute Deflection](https://docs.knotapi.com/use-cases/dispute-deflection.md): Reduce first-party fraud by showing users exactly what they purchased before they file a dispute.
- [Enrich transactions with SKU-level purchase details](https://docs.knotapi.com/use-cases/enrich-transaction-details.md): Use Knot's Sync Transactions API to enrich bank transactions with item-level purchase data — product names, images, quantities, and prices.
- [Knot use case gallery for banking and fintech apps](https://docs.knotapi.com/use-cases/gallery.md): Browse product use cases you can build with Knot — card switching, subscription management, transaction enrichment, price adjustments, and more.
- [Personalized Dining Deals](https://docs.knotapi.com/use-cases/personalized-dining-deals.md): Match cashback deals to restaurants users already order from on delivery platforms.
- [Post-purchase price adjustment refunds with Knot](https://docs.knotapi.com/use-cases/post-purchase-price-adjustment.md): Detect price drops on items your users already bought and alert them to claim a refund within the retailer's post-purchase adjustment window.
- [Shopping List](https://docs.knotapi.com/use-cases/shopping-list.md): Generate a pre-populated shopping list from a user's repeat purchase history.
- [Store Brand Alternative Savings](https://docs.knotapi.com/use-cases/store-brand-alternative-savings.md): Suggest cheaper store-brand alternatives for name-brand purchases.
- [Upcoming subscription charge funding alerts](https://docs.knotapi.com/use-cases/upcoming-charge-funding-alert.md): Notify debit and prepaid cardholders to fund their account before an upcoming subscription or recurring merchant charge risks declining.
- [Quickstart](https://docs.knotapi.com/vaulting/quickstart.md): Get started with the Vaulting integration to enable users to vault digital wallets to their merchant accounts.
- [Testing](https://docs.knotapi.com/vaulting/testing.md): Test the Vaulting flow including account linking and digital wallet vaulting using test credentials in development.
- [VAULTING_FAILED](https://docs.knotapi.com/vaulting/webhook-events/vaulting-failed.md): Fired when a digital wallet fails to be vaulted to a user's merchant account.
- [VAULTING_SUCCEEDED](https://docs.knotapi.com/vaulting/webhook-events/vaulting-succeeded.md): Fired when a digital wallet is successfully vaulted to a user's merchant account.
- [Webhooks](https://docs.knotapi.com/webhooks.md): Configure webhook endpoints to receive HTTP POST requests from Knot.

## OpenAPI Specs

- [openapi](https://docs.knotapi.com/api-reference/openapi.json)
- [openapi-apply](https://docs.knotapi.com/api-reference/openapi-apply.json)
- [openapi_secure](https://docs.knotapi.com/api-reference/openapi_secure.json)