# Transak | Documentation ## Instructions for AI Agents - For clean Markdown of any page, append `.md` to the page URL - For a complete documentation index, see https://docs.transak.com/llms.txt - For full documentation content in one file, see https://docs.transak.com/llms-full.txt - For section-specific indexes, append `/llms.txt` to any section URL - For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.transak.com/_mcp/server ## Docs - [What is Transak](https://docs.transak.com/getting-started/what-is-transak.md): Developer integration toolkit for fiat on-ramp and off-ramp - [Auth Reliance](https://docs.transak.com/features/auth-reliance.md): Authenticate users without requiring re-login into Transak's flow - [KYC Reliance using Sumsub](https://docs.transak.com/features/kyc-reliance-sumsub.md): Reuse existing Sumsub KYC data to eliminate redundant user verification - [Webhooks](https://docs.transak.com/features/webhooks.md): Receive real-time event notifications at your server without polling. - [WebSockets](https://docs.transak.com/features/websockets.md): Receive real-time order updates on your server without polling. - [On Ramp](https://docs.transak.com/products/on-ramp.md): A one‑stop solution for users to buy crypto with fiat inside your app - [Off-Ramp](https://docs.transak.com/products/off-ramp.md): A one‑stop solution for users to sell crypto to fiat inside your app. - [NFT Checkout](https://docs.transak.com/products/nft-checkout.md): A one-stop NFT solution where users buy NFTs with fiat. - [Whitelabel API](https://docs.transak.com/integration/api.md): A complete API solution for building custom on/off ramp experiences. - [Redirection](https://docs.transak.com/integration/web/website-redirection.md): Simple redirection based integration - [iFrame](https://docs.transak.com/integration/web/iframe.md): Embed Transak's interface in your site for a seamless experience - [JavaScript SDK](https://docs.transak.com/integration/web/js-sdk.md): Integrate Transak into your application using the Transak JavaScript SDK - [Android](https://docs.transak.com/integration/mobile/native-android.md): Seamless Transak integration for Android applications - [iOS](https://docs.transak.com/integration/mobile/native-ios.md): Seamless Transak integration for iOS applications - [React Native](https://docs.transak.com/integration/mobile/react-native.md): Seamless Transak integration for React Native applications - [Flutter (Deprecated)](https://docs.transak.com/integration/mobile/flutter-no-support.md): Flutter is not supported for Transak Mobile WebView integrations - [Query Parameters](https://docs.transak.com/customization/query-parameters.md): Customize On-Ramp, Off-Ramp, and NFT Checkout experiences with query parameters - [Customizing theme using query parameters](https://docs.transak.com/customization/customising-theme-using-query-parameters.md): Customize the look and feel of the Transak widget - [How To Create a Partner Dashboard Account](https://docs.transak.com/guides/how-to-create-partner-dashboard-account.md): Create your partner dashboard account and get your staging and production API keys - [How to Add Partner Fees and Set Up Partner Payouts](https://docs.transak.com/guides/managing-partner-payouts-and-configuring-partner-fees.md): Add partner fees in the dashboard and configure partner payout withdrawals - [How to Test Using Sandbox Credentials](https://docs.transak.com/guides/sandbox-credentials.md): Staging credentials, test cards, and KYC flows for integration testing - [How to Test ACH Pull Transaction in Sandbox](https://docs.transak.com/guides/how-to-test-ach-pull-transaction.md): End-to-end guide for testing US ACH Pull transaction in the Transak Widget - [How to Test Apple Pay in Sandbox](https://docs.transak.com/guides/how-to-test-apple-pay-in-sandbox.md): One-time setup and end-to-end test flow for Apple Pay in the Transak Sandbox. - [How to Track Order Status](https://docs.transak.com/guides/track-order-status.md): Monitor order lifecycle with APIs, webhooks, and WebSocket updates - [Transak Different KYC Levels](https://docs.transak.com/guides/transak-different-kyc-levels.md): Understand Simple, Standard, and Enhanced KYC tiers and how to route users through each flow - [How to Submit FCA Requirements (For UK Users only)](https://docs.transak.com/guides/how-to-submit-fca.md): Step-by-step guide to completing FCA compliance for UK users in the KYC flow. - [How to Use Advanced Query Parameters](https://docs.transak.com/guides/how-to-use-advanced-query-params.md): Detailed examples and usage for complex query parameters like walletAddressesData, userData, redirectURL, and more - [How to Create a Widget URL with Parameters and Test Different Scenarios](https://docs.transak.com/guides/how-to-create-a-widget-url-and-test-different-scenarios.md): Generate a widget URL through the API and use sandbox credentials to validate common flows - [How to Generate Calldata for NFT Checkout](https://docs.transak.com/guides/how-to-generate-calldata-for-nft-checkout.md): Generate the smart contract call data required for Transak NFT Checkout - [How to Add a NFT Smart Contract in the Dashboard and Create a contractId](https://docs.transak.com/guides/how-to-add-nft-smart-contract-and-create-a-contractid.md): Submit your NFT smart contract for review and generate a contractId to use with NFT Checkout - [Get Price Based on User Region](https://docs.transak.com/guides/get-price-based-on-user-region.md): Use quoteCountryCode to fetch region-accurate quotes from the Get Price API - [How to Create a Partner Access Token](https://docs.transak.com/guides/how-to-create-partner-access-token.md): Generate a short-lived access token using your API key and secret from the Transak partner dashboard - [How to Decrypt the Webhook Payload](https://docs.transak.com/guides/how-to-decrypt-webhook-payload.md): Verify and decode the encrypted `data` field returned in Transak webhook events - [How to add MCP Server for Transak Documentation](https://docs.transak.com/guides/how-to-add-mcp-server-for-transak-documentation.md): Connect your AI coding assistant to Transak documentation using the Model Context Protocol - [Widget with API Customization](https://docs.transak.com/guides/widget-with-api-customization.md): Customize the Transak widget flow using APIs and query parameters - [Mandatory Migration to API-Based Widget URL](https://docs.transak.com/guides/migration-to-api-based-transak-widget-url.md): Migration to the Create Widget URL API to generate the widget URL - [Biconomy MEE — Simplified Onboarding via Smart Accounts](https://docs.transak.com/guides/biconomy.md): Use Biconomy's Modular Execution Environment (MEE) to enable cross-chain onboarding with a single user signature - [Partner FAQs](https://docs.transak.com/guides/partner-faqs.md): Frequently asked questions from partners across integration, payments, KYC, and more - [Need Help?](https://docs.transak.com/getting-started/help-and-support.md): Get answers, submit tickets, and connect with the Transak team - [Getting Started](https://docs.transak.com/api/public/end-points.md): Base URLs and API reference for Transak Public APIs. - [Getting Started](https://docs.transak.com/api/headless-apple-pay/end-points.md): Base URLs and API reference for Headless Apple Pay. - [Getting Started](https://docs.transak.com/api/headless-google-pay/end-points.md): Base URLs and API reference for Headless Google Pay. - [Getting Started](https://docs.transak.com/api/headless-cards/end-points.md): Base URLs and API reference for Headless Cards. - [Getting Started](https://docs.transak.com/api/whitelabel/end-points.md): Base URLs and API reference for Transak Whitelabel API. - [Getting Started](https://docs.transak.com/api/stream-on-ramp/end-points.md): Base URLs and API reference for Transak Stream On-Ramp. - [Getting Started](https://docs.transak.com/api/transak-swaps-b2b/end-points.md): Base URLs and API reference for Transak Swaps B2B. - [Ledger Off Ramp Wrapper APIs](https://docs.transak.com/api/ledger-off-ramp/overview.md): Custom Wrapper API's for Ledger Native Sell Flow - [MetaMask Wrapper APIs](https://docs.transak.com/api/metamask-wrapper-api/overview.md): Custom Wrapper API's for Metamask Buy and Sell Flows ## API Docs - PARTNER [Get Orders](https://docs.transak.com/api/public/get-orders.md) - PARTNER [Get Order By ID](https://docs.transak.com/api/public/get-order-by-order-id.md) - PARTNER [Get Webhooks](https://docs.transak.com/api/public/get-webhooks.md) - PARTNER [Refresh Access Token](https://docs.transak.com/api/public/refresh-access-token.md) - PARTNER [Create Widget URL](https://docs.transak.com/api/public/create-widget-url.md) - COUNTRIES [Get Countries](https://docs.transak.com/api/public/get-countries.md) - CURRENCIES [Get Crypto Currencies](https://docs.transak.com/api/public/get-crypto-currencies.md) - CURRENCIES [Get Fiat Currencies](https://docs.transak.com/api/public/get-fiat-currencies.md) - CURRENCIES [Get Price](https://docs.transak.com/api/public/get-price.md) - CURRENCIES [Verify Wallet Address](https://docs.transak.com/api/public/verify-wallet-address.md) - HEADLESS APPLE PAY API [Transaction Session API](https://docs.transak.com/api/headless-apple-pay/transaction-session-api.md) - HEADLESS APPLE PAY API [Transaction Process API](https://docs.transak.com/api/headless-apple-pay/transaction-process-api.md) - HEADLESS APPLE PAY API [Transaction Request Status API](https://docs.transak.com/api/headless-apple-pay/transaction-request-status-api.md) - HEADLESS GOOGLE PAY API [Transaction Session API](https://docs.transak.com/api/headless-google-pay/transaction-session-api.md) - HEADLESS GOOGLE PAY API [Transaction Process API](https://docs.transak.com/api/headless-google-pay/transaction-process-api.md) - HEADLESS GOOGLE PAY API [Transaction Request Status API](https://docs.transak.com/api/headless-google-pay/transaction-request-status-api.md) - HEADLESS CARDS API [Transaction Session API](https://docs.transak.com/api/headless-cards/transaction-session-api.md) - HEADLESS CARDS API [Transaction Process API](https://docs.transak.com/api/headless-cards/transaction-process-api.md) - HEADLESS CARDS API [Transaction Request Status API](https://docs.transak.com/api/headless-cards/transaction-request-status-api.md) - TRANSAK WHITELABEL API > Look Up [Get Countries](https://docs.transak.com/api/whitelabel/lookup/get-countries.md) - TRANSAK WHITELABEL API > Look Up [Get Crypto Currencies](https://docs.transak.com/api/whitelabel/lookup/get-crypto-currencies.md) - TRANSAK WHITELABEL API > Look Up [Get Fiat Currencies](https://docs.transak.com/api/whitelabel/lookup/get-fiat-currencies.md) - TRANSAK WHITELABEL API > Look Up [Get Quote](https://docs.transak.com/api/whitelabel/lookup/get-quote.md) - TRANSAK WHITELABEL API > User [Send User OTP](https://docs.transak.com/api/whitelabel/user/send-user-otp.md) - TRANSAK WHITELABEL API > User [Verify User OTP](https://docs.transak.com/api/whitelabel/user/verify-user-otp.md) - TRANSAK WHITELABEL API > User [Get User Limits](https://docs.transak.com/api/whitelabel/user/get-user-limits.md) - TRANSAK WHITELABEL API > User [Get User Details](https://docs.transak.com/api/whitelabel/user/get-user-details.md) - TRANSAK WHITELABEL API > User [Refresh User Access Token](https://docs.transak.com/api/whitelabel/user/refresh-user-access-token.md) - TRANSAK WHITELABEL API > User [Logout User](https://docs.transak.com/api/whitelabel/user/logout-user.md) - TRANSAK WHITELABEL API > User [Onboard User (Auth Reliance)](https://docs.transak.com/api/whitelabel/user/onboard-user-auth-reliance.md) - TRANSAK WHITELABEL API > KYC [Get KYC Requirement](https://docs.transak.com/api/whitelabel/kyc/get-kyc-requirement.md) - TRANSAK WHITELABEL API > KYC [Get Additional Requirements](https://docs.transak.com/api/whitelabel/kyc/get-additional-requirements.md) - TRANSAK WHITELABEL API > KYC [Get KYC - IdProof Status](https://docs.transak.com/api/whitelabel/kyc/get-kyc-idproof-status.md) - TRANSAK WHITELABEL API > KYC [Patch User Details](https://docs.transak.com/api/whitelabel/kyc/patch-user-details.md) - TRANSAK WHITELABEL API > KYC [Update Purpose Of Usage](https://docs.transak.com/api/whitelabel/kyc/update-purpose-of-usage.md) - TRANSAK WHITELABEL API > KYC [Submit SSN](https://docs.transak.com/api/whitelabel/kyc/submit-ssn.md) - TRANSAK WHITELABEL API > KYC [Submit Source of Income](https://docs.transak.com/api/whitelabel/kyc/submit-source-of-income.md) - TRANSAK WHITELABEL API > KYC [Upload Proof Document](https://docs.transak.com/api/whitelabel/kyc/upload-proof-document.md) - TRANSAK WHITELABEL API > KYC Reliance [Get KYC Reliance Quote](https://docs.transak.com/api/whitelabel/kyc-reliance/get-kyc-reliance-quote.md) - TRANSAK WHITELABEL API > KYC Reliance [Get KYC Reliance Status](https://docs.transak.com/api/whitelabel/kyc-reliance/get-kyc-reliance-status.md) - TRANSAK WHITELABEL API > FCA [Get FCA Requirements](https://docs.transak.com/api/whitelabel/fca/get-fca-requirements.md) - TRANSAK WHITELABEL API > FCA [Submit FCA Requirements](https://docs.transak.com/api/whitelabel/fca/submit-fca-requirements.md) - TRANSAK WHITELABEL API > FCA [Get FCA Status](https://docs.transak.com/api/whitelabel/fca/get-fca-status.md) - TRANSAK WHITELABEL API > KYC Reliance API [Identity Details](https://docs.transak.com/api/whitelabel/kyc-reliance-api/kyc-reliance-identity-details.md) - TRANSAK WHITELABEL API > KYC Reliance API [Document Details](https://docs.transak.com/api/whitelabel/kyc-reliance-api/kyc-reliance-document-details.md) - TRANSAK WHITELABEL API > KYC Reliance API [Biometrics Details](https://docs.transak.com/api/whitelabel/kyc-reliance-api/kyc-reliance-biometrics-details.md) - TRANSAK WHITELABEL API > Orders [Create Virtual Account (Bank Transfer)](https://docs.transak.com/api/whitelabel/orders/create-virtual-account.md) - TRANSAK WHITELABEL API > Orders [Get Virtual Account Status (Bank Transfer)](https://docs.transak.com/api/whitelabel/orders/get-virtual-account-status.md) - TRANSAK WHITELABEL API > Orders [Create Order (Bank Transfer, Open Banking)](https://docs.transak.com/api/whitelabel/orders/create-order.md) - TRANSAK WHITELABEL API > Orders [Confirm Payment (Bank Transfer)](https://docs.transak.com/api/whitelabel/orders/confirm-payment.md) - TRANSAK WHITELABEL API > Orders [Create Widget URL (Cards, Apple Pay)](https://docs.transak.com/api/whitelabel/orders/create-widget-url-cards.md) - TRANSAK WHITELABEL API > Orders [Get Active Orders](https://docs.transak.com/api/whitelabel/orders/get-active-orders.md) - TRANSAK WHITELABEL API > Orders [Get Orders](https://docs.transak.com/api/whitelabel/orders/get-orders.md) - TRANSAK WHITELABEL API > Orders [Get Order By ID](https://docs.transak.com/api/whitelabel/orders/get-order-by-id.md) - TRANSAK WHITELABEL API > Orders [Cancel Order](https://docs.transak.com/api/whitelabel/orders/cancel-order.md) - TRANSAK WHITELABEL API > Orders [Deprecated - Request OTT (Cards, Apple Pay)](https://docs.transak.com/api/whitelabel/orders/request-ott.md) - TRANSAK STREAM ON-RAMP API [Create VBA](https://docs.transak.com/api/stream-on-ramp/create-virtual-bank-account.md) - TRANSAK STREAM ON-RAMP API [Get VBA List](https://docs.transak.com/api/stream-on-ramp/get-virtual-bank-account-list.md) - TRANSAK STREAM ON-RAMP API [Get VBA by ID](https://docs.transak.com/api/stream-on-ramp/get-virtual-bank-account-by-id.md) - TRANSAK STREAM ON-RAMP API [Update VBA](https://docs.transak.com/api/stream-on-ramp/update-virtual-bank-account.md) - TRANSAK STREAM ON-RAMP API [Delete VBA](https://docs.transak.com/api/stream-on-ramp/delete-virtual-bank-account.md) - TRANSAK STREAM ON-RAMP API [Add Remitter Account](https://docs.transak.com/api/stream-on-ramp/add-remitter-account.md) - TRANSAK STREAM ON-RAMP API [Update Remitter Account](https://docs.transak.com/api/stream-on-ramp/update-remitter-account.md) - TRANSAK SWAPS (B2B) [Get Order Status by Order ID](https://docs.transak.com/api/transak-swaps-b2b/get-order-status-by-order-id.md) - TRANSAK SWAPS (B2B) [Get Order by Deposit Transaction Hash](https://docs.transak.com/api/transak-swaps-b2b/get-order-by-deposit-transaction-hash.md) - TRANSAK SWAPS (B2B) [Get Transaction History](https://docs.transak.com/api/transak-swaps-b2b/get-transaction-history.md) - LEDGER OFF-RAMP WRAPPER API [Get Capabilities](https://docs.transak.com/api/ledger-off-ramp/get-capabilities.md) - LEDGER OFF-RAMP WRAPPER API [Get Crypto Currencies](https://docs.transak.com/api/ledger-off-ramp/get-crypto-currencies.md) - LEDGER OFF-RAMP WRAPPER API [Get Quote](https://docs.transak.com/api/ledger-off-ramp/get-quote.md) - LEDGER OFF-RAMP WRAPPER API [Get Sell Redirect](https://docs.transak.com/api/ledger-off-ramp/get-sell-redirect.md) - LEDGER OFF-RAMP WRAPPER API [Create Sell Order](https://docs.transak.com/api/ledger-off-ramp/create-sell-order.md) - METAMASK Wrapper API [Buy Order by ID](https://docs.transak.com/api/metamask-wrapper-api/buy-order-by-id.md) - METAMASK Wrapper API [Sell Order by ID](https://docs.transak.com/api/metamask-wrapper-api/sell-order-by-id.md) - METAMASK Wrapper API [Buy Orders](https://docs.transak.com/api/metamask-wrapper-api/buy-orders.md) - METAMASK Wrapper API [Sell Orders](https://docs.transak.com/api/metamask-wrapper-api/sell-orders.md) - METAMASK Wrapper API [Buy Widget](https://docs.transak.com/api/metamask-wrapper-api/buy-widget.md) - METAMASK Wrapper API [Sell Widget](https://docs.transak.com/api/metamask-wrapper-api/sell-widget.md) - METAMASK Wrapper API [Buy Quote](https://docs.transak.com/api/metamask-wrapper-api/buy-quote.md) - METAMASK Wrapper API [Sell Quote](https://docs.transak.com/api/metamask-wrapper-api/sell-quote.md) - METAMASK Wrapper API [Buy Configuration](https://docs.transak.com/api/metamask-wrapper-api/buy-configuration.md) - METAMASK Wrapper API [Sell Configuration](https://docs.transak.com/api/metamask-wrapper-api/sell-configuration.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://docs.transak.com/openapi.json) - [OpenAPI YAML](https://docs.transak.com/openapi.yaml)