Skip to content

Fundamentals

Test Mode

Build and test with free, non-binding SignatureAPI test envelopes: no emails reach recipients, documents carry a watermark, and switching to live is one key.

When you sign up for SignatureAPI, you get a free test API key. Test API keys let you create test envelopes, great for trying out your workflows.

The API key decides the mode. Each mode has its own envelopes, webhook endpoints, and senders:

Test mode and live mode
Test mode and live mode6 parts: key_test_ key, Test envelope, Test endpoints, key_live_ key, Live envelope, Live endpoints. Connections: key_test_ key to Test envelope (creates); Test envelope to Test endpoints (events); key_live_ key to Live envelope (creates); Live envelope to Live endpoints (events).Test modeLive modekey_test_ keyTest envelopeTest endpointskey_live_ keyLive envelopeLive endpointscreateseventscreatesevents
Test modeLive modekey_test_ keyTest envelopeTest endpointskey_live_ keyLive envelopeLive endpointscreateseventscreatesevents
Diagram as text

Parts

  • key_test_ key: One per account. Free to use.
  • Test envelope: No emails sent: preview them in the Dashboard. Documents carry a watermark and are not billed.
  • Test endpoints: Receive events from test envelopes only.
  • key_live_ key: Needs an active paid plan.
  • Live envelope: Emails go to real recipients. Legally binding and billed.
  • Live endpoints: Receive events from live envelopes only.

Connections

  • key_test_ key to Test envelope: creates
  • Test envelope to Test endpoints: events
  • key_live_ key to Live envelope: creates
  • Live envelope to Live endpoints: events

Test envelopes don’t send emails

Don’t be afraid of flooding your customer’s inboxes with test emails. Emails from test envelopes don’t get sent to recipients. But, you can inspect them in your Dashboard’s Email view.

Dashboard Emails page with Test Mode on, a notice that only test-mode emails are shown, and a list of emails with recipient, subject and sent time
Emails, with Test Mode on

Where you can see the email contents:

Detail of a test email in the Dashboard: sent time, subject, recipient, sender and envelope on the left, and the rendered email content on the right
Email detail

Test envelopes are not legally-binding

A notice watermark on documents in test envelopes makes them non-binding.

Top of a test document in the signing ceremony, with the notice NULL AND VOID, NON-BINDING TEST DOCUMENT in red
The test-mode notice on every page

Test envelopes are free

We don’t bill you for test envelopes.

Test mode and live mode differences

Test modeLive mode
API key prefixkey_test_key_live_
Emails sentNo. Preview in Dashboard.Yes, to real recipients.
Legally bindingNo. Documents show a watermark.Yes.
BillingFreeCounted toward your plan.
WebhooksDelivered to test endpointsDelivered to live endpoints

You can use test mode and live mode at the same time. They are independent: test envelopes, webhooks, and senders are separate from live ones.

Switch to live mode

When you are ready to start sending legally-binding envelopes, go to the API Key section of your Dashboard. Follow the instructions to create a live API key.

Live keys need an active paid plan. If your account has no plan yet, subscribe to one in billing settings first.

Replace key_test_ with your new key_live_ key in your API calls. No other code changes are needed.

Before you send live envelopes, check the rest of your integration:

Go-live checklist

0 of 9 done. Your ticks are not saved on this page.