Skip to content
On this page

Getting started

Markdown

Sandbox

Try sending, signing and the API with test data. Sandbox envelopes aren't legally binding and don't count toward your plan.

Turn on Sandbox

Turn on Sandbox at the bottom of the sidebar, or with the Sandbox switch at the top of Developers. A banner reading Sandbox · test data only appears above every page. Select Exit sandbox in the banner, or turn the switch off, to go back to live data.

While Sandbox is on, you only see test envelopes, templates and webhook endpoints. Live data is hidden, and anything you create is a test object. Switching modes takes you back to the envelope list.

The choice is saved in your browser session for each workspace. It doesn't change what other members see, and it doesn't change the mode of an API key.

Sandbox is available on every plan and to every workspace role. A platform can also create test-only workspaces, which always show Sandbox data and can't switch to live.

Test API keys

Test keys work on every plan. In Developers → API keys, select Create key and choose Test under Key mode. Test workspace keys start with rk_test_; live keys start with rk_live_. The secret is shown once, so copy it before you close the dialog.

bash
curl https://esignstack.app/api/v1/envelopes \
  -H "Authorization: Bearer $ESIGNSTACK_TEST_KEY"

A test key can create envelopes from a file or template and send them, and it can open signing and editor sessions. Everything it creates is a test object, marked as described below, and nothing is counted toward your plan.

The key decides the mode. A test key only sees test envelopes, files and templates, and a live key only sees live ones. Keys created through the API with a test key are always test keys. Turning on Sandbox in the app doesn't change this. Test objects can't be promoted to live, so create a live key when your integration is ready.

Brand kits and identity providers are shared with live data. A test key can read the effective branding for an envelope, but creating, changing or deleting a brand kit, or using identity-provider endpoints, needs a live key. Those requests return 403 with error.code: "live_key_required".

Folders and filing rules are shared too. A test key can list them and move test envelopes and templates into folders, but creating, changing or deleting a folder or filing rule needs a live key.

See API quick start for abilities and request basics.

Who can receive test emails

Sandbox emails are only delivered to verified members of the workspace, including you. Email to any other address isn't sent. To test a signing flow, add a member's email as the recipient, open the invitation from that inbox and sign as that person. The signer still goes through any verification the envelope asks for.

SMS verification isn't available in Sandbox. Sending a test envelope with an SMS-verified recipient fails, and the API returns 422. Use email verification or an access code instead.

How test envelopes look

  • Email subjects start with [TEST], and the body says TEST — not legally binding.
  • Every page of the PDF, including the certificate, is marked TEST — not legally binding.
  • Completed test PDFs don't get the production seal or timestamp.

Don't send test PDFs to anyone as signed agreements.

What isn't counted

Sandbox envelopes aren't counted toward any allowance. This covers sends in the app, kiosk and direct-link submissions, API and MCP sends, and signing sessions. They don't create billable API extras, and they don't trigger allowance emails. See Plans and billing.

Webhooks

Sandbox events have "livemode": false and only go to test webhook endpoints. Live endpoints never receive them. To create a test endpoint, turn on Sandbox and add the endpoint in Developers → Webhooks, or create it with a test key.

json
{
  "object": "event",
  "type": "envelope.completed",
  "livemode": false,
  "data": {
    "object": {
      "object": "envelope",
      "livemode": false,
      "status": "completed"
    }
  }
}

Send test event sends a sample event in the endpoint's own mode. A sample sent to a live endpoint has "livemode": true. See Webhooks.

Delete sandbox data

Owners and admins can clear out test data from Developers → Overview, under Delete sandbox data. Type DELETE SANDBOX DATA and select Delete sandbox data.

This permanently deletes the workspace's test data:

  • Test envelopes, including those in the trash, with their recipients and history
  • Uploaded test files and test templates
  • Test editor sessions
  • Test events, webhook endpoints and their deliveries

Live data, API keys, members, workspace settings and other workspaces aren't touched. Files that live data still uses are kept.

Note

A legal hold on the workspace, or on any envelope in it, blocks the whole deletion. Clear the hold first.

After deleting, use a new Idempotency-Key for API requests. A key you used before may replay its earlier response for up to 24 hours.