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:
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.
Where you can see the email contents:
Test envelopes are not legally-binding
A notice watermark on documents in test envelopes makes them non-binding.
Test envelopes are free
We don’t bill you for test envelopes.
Test mode and live mode differences
| Test mode | Live mode | |
|---|---|---|
| API key prefix | key_test_ | key_live_ |
| Emails sent | No. Preview in Dashboard. | Yes, to real recipients. |
| Legally binding | No. Documents show a watermark. | Yes. |
| Billing | Free | Counted toward your plan. |
| Webhooks | Delivered to test endpoints | Delivered 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