Sandbox

What is the Sandbox?

The Deel API Sandbox is a completely isolated testing environment that mirrors production functionality without affecting real data, triggering actual payments, or creating legal contracts. It’s pre-populated with sample data so you can start testing immediately.

• Safe Testing: Test without real money, contracts, or legal implications.
• Pre-populated Data: Use sample contracts, workers, and organizations right away.
• Full API Access: Experiment with all production endpoints in a safe environment.
• Isolated Environment: Keep test data and actions completely separate from production.

Sandbox vs Production

Pre-populated Sample Data

Your sandbox comes with ready-to-use data for testing:

Sample Workers

The sandbox includes pre-created workers across different contract types:

Test Credentials

Use these test workers to simulate different scenarios:

1
// Test user credentials for webhook testing
2
{
3
  "worker_id": "test_worker_001",
4
  "email": "test.worker@deel-sandbox.com",
5
  "status": "active"
6
}
7
8
// Test organization admin
9
{
10
  "admin_id": "test_admin_001",
11
  "email": "admin@deel-sandbox.com",
12
  "organization": "org_main_001"
13
}

How Sandbox Differs from Production

Payments & Invoicing

• Sandbox: All payments are simulated. Invoice status changes to “paid” without actual fund transfers
• Production: Real money is transferred; payment failures are real

Contract Signing

• Sandbox: E-signatures are simulated; documents are generated but not legally binding
• Production: Real DocuSign/SignNow integration; legally binding contracts

Webhooks

• Sandbox: Webhooks fire normally; test webhook events in isolated environment
• Production: Webhooks trigger real business logic

Background Checks & Verifications

• Sandbox: Always return success/approved status after 30 seconds
• Production: Real third-party checks (Veriff, Sterling, etc.)

Email Notifications

• Sandbox: Emails are not sent to workers; check via API only
• Production: Real emails sent to workers and admins

Testing Common Scenarios

$
# Create a new contractor agreement in sandbox
$
curl -X POST "https://api-sandbox.demo.deel.com/rest/v2/contracts" \
>
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
>
  -H "Content-Type: application/json" \
>
  -d '{
>
    "client_id": "org_main_001",
>
    "worker_email": "new.contractor@example.com",
>
    "job_title": "Backend Developer",
>
    "scope": "Software Development",
>
    "rate": 100,
>
    "rate_type": "hourly"
>
  }'

Resetting Sandbox Data

You can reset your sandbox environment to start fresh:

1. Go to Developer Center → API Sandbox
2. Click Reset Sandbox Data
3. Confirm the reset

Frequently Asked Questions

Next Steps