Skip to main content

​
Getting started

​
Generate a sandbox API key

  1. Request Access - Visit hifi.com/contact to schedule a call with our team and get onboarded.
  2. Navigate to API Keys - Once approved, go to the Developer Dashboard
  3. Create New Key - Click the “New API Key” button under Sandbox
Keep your sandbox API key secure and never commit it to version control. Use environment variables to store API keys in your applications.

​
Sandbox Base URL

All sandbox API requests should be made to:
Example request:

​
Sandbox vs Production

The sandbox environment is designed to simulate production behavior while providing a safe testing environment:

​
Automated KYC Approval

In sandbox, the KYC process is streamlined for testing:
  • Typically Auto-Approved - KYC submissions are usually approved within minutes
  • Compliance Checks Still Apply - Some compliance checks (like PEP screening) may still block approval even in sandbox
  • Dummy Data - Use any test personal information and documents
While KYC is typically auto-approved in sandbox, certain compliance checks may still block approval. For example, PEP (Politically Exposed Person) screening can prevent sandbox users from unlocking rails even in the test environment.
In production, KYC applications undergo real compliance review

​
Simulated Transactions

All money movement in sandbox is simulated:
  • Virtual Deposits - Use an endpoint to mimic bank deposits
  • Testnet Token - Transaction uses testnet tokens and is processed on a testnet network
  • Testnet Wallets - All wallet addresses are on blockchain testnets

​
Simulated Failures and Returns

Failures and returns can be forced in sandbox, following the same statuses and webhooks as a real one:
  • Forced outcomes - Pass sandboxScenario when creating an offramp (CRYPTO_FAILED, FIAT_FAILED, or COMPLETED), or when simulating the deposit that creates an onramp (FIAT_FAILED or COMPLETED)
  • Automatic returns - Every forced outcome resolves to its true terminal status 3 minutes later: CRYPTO_RETURNED for offramps, FIAT_RETURNED for onramps. No follow-up call is needed
See Magic values for every value you can pass and the outcome each one forces, including KYC.
sandboxScenario is rejected with a 400 in production, and the simulate-deposit endpoint does not exist there.

​
Transitioning to production

When you’re ready to move from sandbox to production:
  1. Generate production API keys in the dashboard
  2. Update your base URL from sandbox.hifibridge.com to production.hifibridge.com
  3. Update API keys in your environment variables
  4. Remove simulation calls - Delete any simulate-deposit endpoint usage, and drop sandboxScenario from offramp and simulate-deposit requests
  5. Enable real KYC - Provide real user information and documents
  6. Test thoroughly - Start with small transactions before scaling
Never use sandbox API keys in production or production keys in sandbox. They are environment-specific and won’t work cross-environment.

​
Getting help

If you encounter issues or have suggestions for improving the sandbox experience:
  • 📧 Email: support@hifi.com
  • 💬 Slack: Message us in our shared Slack channel
The sandbox environment is continuously updated to reflect production changes. If you notice discrepancies between sandbox and production behavior, please let us know.