Welcome to Karma Business API
The Karma Business API enables your users to convert cryptocurrency (like your token) into stablecoins and fiat currency. This B2B2C API handles the entire offramp flow - from KYC verification to bank deposits.Your Use Case
If you’re building an app where users hold tokens and need to cash out to pay bills or access their funds, this API is for you. Example flow:- Your user holds your token in your app
- User wants to convert tokens → USDC → USD in their bank account
- Your app uses this API to create an offramp address
- User sends crypto to that address
- Fiat appears in their bank account automatically
Base URL
This documentation is for the development environment. Production URLs will be different.
Key Terminology
Understanding these terms will help you integrate faster:| Term | What It Means |
|---|---|
| Business Customer / Partner | You - the company integrating this API |
| End-User | Your app users who want to onramp/offramp |
| External User ID | Your internal ID for your user (like user_123 from your database) |
| Custom KYC | You handle identity verification using your own KYC provider (Sumsub, Persona, Onfido) |
| ToS Link | Terms of Service acceptance link from Bridge |
| Signed Agreement ID | ID received after user accepts ToS, required for KYC submission |
| Endorsement | Bridge’s approval system - must be “approved” before creating accounts |
| Virtual Account | Bank details for onramp (fiat → crypto) |
| Liquidation Address | Crypto address for offramp (crypto → fiat) |
Integration Overview
Here’s what you’ll do to integrate: One-time setup:- Register your business account via partner portal (self-service)
- Wait for admin approval
- Log in to portal and generate your API key
- Create end-user record with
externalUserIdandemail - Generate ToS link for user to accept Bridge’s Terms of Service
- Collect KYC data using your own verification provider
- Submit KYC data with
signed_agreement_idto create Bridge customer - Poll customer status until endorsement is approved
- Create liquidation address (crypto → fiat) or virtual account (fiat → crypto)
- User can now onramp/offramp funds
Need Help?
- Email: [email protected]
- Telegram: Join our community at t.me/karmawallet
- Documentation: Check out our comprehensive guides