Whitelabel API
A complete API solution for building custom on/off ramp experiences.
The OZZOBiT Whitelabel API provides a comprehensive REST API that allows you to build fully custom on-ramp and off-ramp experiences. With complete control over the user interface and user flow, you can integrate crypto purchasing and selling capabilities seamlessly into your application while OZZOBiT handles all compliance, payment processing, and settlement.
Who Should Use This?
| Use Case | Why Whitelabel API? |
|---|---|
| Crypto Wallets | Build native buy/sell flows that match your wallet design language |
| DEXs / DeFi Apps | Integrate fiat on/off ramps directly into your DeFi protocol |
| Fintech Platforms | Add crypto services to banking or payment applications |
| Enterprise Solutions | Full control over UX with white-glove compliance support |
Key Capabilities
Partner Integration Prerequisites
Create Partner Account
Sign up at the Partner Dashboard to obtain your API keys.
Generate API Keys
Navigate to Settings → API Keys in your dashboard. Create a new key pair (public key + secret key). Store the secret key securely.
Configure IP Whitelist
Add your server IP addresses to the whitelist in the dashboard for security. All API calls must originate from whitelisted IPs.
Limitations
| Limitation | Details | Workaround |
|---|---|---|
| IP Whitelisting Required | All API calls must come from whitelisted IPs | Contact support to add/modify IP ranges |
| Rate Limits | API calls are rate-limited per partner | Implement caching for lookup data |
| No Widget UI | Whitelabel API does not include any UI components | Build your own UI or use Widget + API hybrid |
| Sandbox Testing | Use sandbox environment before production | Get sandbox credentials from dashboard |
All Whitelabel API requests must originate from IP addresses that have been whitelisted in your partner dashboard. Requests from non-whitelisted IPs will be rejected with a 403 Forbidden response.
API Overview
The Whitelabel API is organized into these main categories:
- Lookup APIs - Get reference data (countries, currencies, quotes)
- User APIs - Manage users, authentication, KYC documents
- KYC APIs - Submit and monitor KYC verification status
- KYC Reliance APIs - External KYC provider integration
- Orders APIs - Create, query, and manage orders
API Categories
Retrieve reference data needed to build your UI:
| Endpoint | Description |
|---|---|
| GET /lookup/countries | List all supported countries with their features |
| GET /lookup/crypto-currencies | List all supported cryptocurrencies |
| GET /lookup/fiat-currencies | List all supported fiat currencies |
| GET /lookup/quote | Get real-time exchange rate quote |
Manage user accounts and authentication:
| Endpoint | Method | Description |
|---|---|---|
| POST /user/send-otp | POST | Send OTP code to user email/phone |
| POST /user/verify-otp | POST | Verify OTP code for user authentication |
| POST /user/create | POST | Create a new user account |
| GET /user/:id | GET | Get user details by ID |
| PUT /user/:id | PUT | Update user information |
| POST /user/upload-kyc-documents | POST | Upload KYC documents for a user |
| POST /user/initiate-kyc-verification | POST | Start KYC verification process |
| POST /user/create-auth-reliance | POST | Create user using auth reliance |
Manage Know Your Customer verification:
| Endpoint | Method | Description |
|---|---|---|
| GET /kyc/status | GET | Get KYC status for a user |
| GET /kyc/status/partner-customer-id | GET | Get KYC status by partner customer ID |
| POST /kyc/submit | POST | Submit KYC information |
| POST /kyc/skip | POST | Skip KYC for eligible users |
| GET /kyc/required-fields | GET | Get required KYC fields for country |
| GET /kyc/verification-link | GET | Get KYC verification link for user |
| GET /kyc/supported-countries | GET | List countries supporting KYC |
| GET /kyc/required-documents | GET | Get required document types |
| GET /kyc/document-upload-url | GET | Get presigned URL for document upload |
Integrate with external KYC providers:
| Endpoint | Method | Description |
|---|---|---|
| POST /kyc-reliance/submit | POST | Submit external KYC reliance request |
| GET /kyc-reliance/status | GET | Check KYC reliance status |
Create and manage buy/sell orders:
| Endpoint | Method | Description |
|---|---|---|
| POST /orders/create | POST | Create a new order (buy or sell) |
| GET /orders/:id | GET | Get details of a specific order |
| GET /orders/partner-order-id/:id | GET | Get order by partner reference ID |
| GET /orders/list | GET | List orders with filtering options |
| POST /orders/:id/complete | POST | Mark an order as completed |
| POST /orders/:id/cancel | POST | Cancel an existing order |
| GET /orders/:id/fee-breakdown | GET | Get fee breakdown for an order |
| GET /orders/:id/status | GET | Get current status of an order |
| GET /orders/history | GET | Get order history for a partner |
Check out our Whitelabel API Endpoints page for full documentation including request/response schemas, error codes, and code examples for each endpoint.