Sandbox
Overview
The Compliancely Sandbox allows you to develop and test your integration without consuming production resources or using real taxpayer data.
The sandbox simulates API behavior and provides deterministic responses for supported products, enabling you to validate your integration before moving to production.
Before You Begin
Ensure you have:
- A registered Compliancely account
- Sandbox password (available from the Developers section in the web app)
- API documentation
Accessing the Sandbox
https://sandbox.compliancely.comThis URL is used for every sandbox API request.
Authentication
Sandbox authentication uses the same authentication flow as Production.
Use:
- Registered email address
- Sandbox password
Generate an access token using the V2 Authentication API.
Example
POST /api/v2/auth/token
The returned access token can then be used for all sandbox API requests.
Token Lifetime
| Token | Validity |
|---|---|
| Access Token | 1 Hour |
| Refresh Token | 24 Hours |
Use the Refresh Token endpoint whenever the access token expires.
If a 401 Unauthorized response is received, generate a new access token using your login credentials.
Sandbox Environment
The sandbox environment is completely isolated from Production.
| Sandbox | Production |
|---|---|
| Test data only | Live data |
| No billing | Standard billing applies |
| Safe for development | Live customer processing |
| Simulated responses | Real provider responses |
Moving to Production
Before switching to Production, ensure that:
- Authentication is updated to the Production endpoint.
- The Production Base URL is used.
- Your application handles production error scenarios.
- Webhooks are configured using production endpoints.
- Billing has been configured.