Sandbox API base URL
Important notes
- Crypto deposits – Use simulator endpoints to deposit crypto in the sandbox.
- Compliance screening – All checks are simulated and do not reflect real verification.
Overview
Use the sandbox to simulate the complete customer lifecycle:- Create customers
- Simulate KYB verification
- Change compliance status
Authentication
All requests require API key and secret authentication. Include theApi-Version header:
1. Create a customer
Create a new customer in the sandbox environment. Endpoint:POST /customers
Request Example
Response
2. Simulate customer KYB
Generate KYB data and simulate KYB verification for an existing customer. Endpoint:POST /simulator/customer-kyb
Simulator endpoints are sandbox-only and may not appear in the public API Reference.
Request Schema
Request Example
Use cases
- Simulate KYB completion after customer creation
- Test different country-specific flows
- Generate synthetic KYB data for testing
3. Change compliance status
Simulate compliance status changes for customers or counterparties. Endpoint:POST /simulator/compliance
Customer compliance
Request Schema
Available customer status values
activein_compliance_reviewcompliance_rejectedcreatedkyb_in_progresskyb_expiredkyb_missing_informationaccount_onboarding_pending
Request Example
Counterparty compliance
Request Schema
Available counterparty status values
activedeletedin_compliance_reviewcompliance_rejected
Request Example
Response
Use cases
- Test compliance workflow transitions
- Simulate rejected customers/counterparties
- Enable customers/counterparties for transactions
- Test system behavior with different compliance states
Common testing workflows
Complete customer onboarding flow
-
Create Customer
-
Simulate KYB Verification
-
Activate Customer
What’s next?
- Onboard your first customer: Create Your First Customer
- Add a counterparty: Create Your Customer’s First Counterparty
- Create your first transaction: Create Your First Onramp Transaction or Create Your First Offramp Transaction

