Whitelabel API Endpoints
Getting started with the OZZOBiT Whitelabel API
The OZZOBiT Whitelabel API provides a comprehensive REST API for building fully custom on-ramp and off-ramp experiences. Unlike the Public API (read-only), the Whitelabel API allows you to create orders, manage users, handle KYC, and control the entire transaction flow.
Base URL
texttext
// Production
https://OZZOBiT.com/api/api/v2
// Staging/Sandbox
https://staging-OZZOBiT.com/api/api/v2Authentication
The Whitelabel API uses Bearer token authentication:
texttext
Authorization: Bearer YOUR_ACCESS_TOKENAccess Token Required
You must generate an access token using your secret API key before making Whitelabel API calls. See our access token guide for details.
API Categories
| Category | Description | Endpoints |
|---|---|---|
| Lookup | Reference data and quotes | 4 endpoints |
| User | User management and auth | 8 endpoints |
| KYC | Know Your Customer verification | 9 endpoints |
| KYC Reliance | External KYC provider integration | 2 endpoints |
| Orders | Order lifecycle management | 9 endpoints |
All Endpoints
| Endpoint | Method | Description |
|---|---|---|
| /lookup/countries | GET | Get supported countries |
| /lookup/crypto-currencies | GET | Get supported cryptocurrencies |
| /lookup/fiat-currencies | GET | Get supported fiat currencies |
| /lookup/quote | POST | Get exchange rate quote |
| /user/send-otp | POST | Send OTP to user email/phone |
| /user/verify-otp | POST | Verify OTP code |
| /user/create | POST | Create a new user |
| /user/:id | GET | Get user details |
| /user/:id | PUT | Update user information |
| /user/upload-kyc-documents | POST | Upload KYC documents |
| /user/initiate-kyc-verification | POST | Start KYC verification |
| /user/create-auth-reliance | POST | Create user via auth reliance |
| /kyc/status | GET | Get KYC status |
| /kyc/status/partner-customer-id | GET | Get KYC status by partner ID |
| /kyc/submit | POST | Submit KYC data |
| /kyc/skip | POST | Skip KYC if eligible |
| /kyc/required-fields | GET | Get required KYC fields |
| /kyc/verification-link | GET | Get KYC verification link |
| /kyc/supported-countries | GET | List KYC supported countries |
| /kyc/required-documents | GET | Get required document types |
| /kyc/document-upload-url | GET | Get presigned upload URL |
| /kyc-reliance/submit | POST | Submit external KYC reliance |
| /kyc-reliance/status | GET | Check reliance status |
| /orders/create | POST | Create a new order |
| /orders/:id | GET | Get order details |
| /orders/partner-order-id/:id | GET | Get order by partner ID |
| /orders/list | GET | List all orders |
| /orders/:id/complete | POST | Complete an order |
| /orders/:id/cancel | POST | Cancel an order |
| /orders/:id/fee-breakdown | GET | Get fee breakdown |
| /orders/:id/status | GET | Get current order status |
| /orders/history | GET | Get order history |