Test environments and readiness
Establish a safe test plan and verify the account settings that shape your integration.
Confirm the test setup
Newer keys carry a sandbox or production type. Creation uses that type to mark the session for testing; legacy keys use the account’s testing setting. Confirm the supported host and behavior for your account before executing examples.
Session access checks are vendor scoped. Separate data namespaces, suppressed notifications, and billing behavior must be verified for the selected test setup.
Record your integration profile
Keep a non-secret profile of the account behavior your integration depends on. This makes test results reproducible and avoids surprises when moving between accounts.
| Setting | What to confirm |
|---|---|
| Notary routing | Specific assignment, internal pool, network pool, and any fallback. |
| Dispatch | What triggers an open call and whether strict scheduling applies. |
| Invitations | Who sends links and which suppression settings apply. |
| Documents | Preparation hold, release policy, and webhook delivery mode. |
| Feature access | Webhook enablement, team roles, templates, and required product access. |
| Billing | Who pays and which test actions have side effects. |
Use repeatable fixtures
Test with synthetic participants and a small, readable sample PDF. Keep fixture documents and expected outputs versioned with the integration.
- Use a fresh application correlation reference for each new test session.
- Store returned session IDs so retries can be investigated.
- Never treat a placeholder Base64 string as a valid file.
- Test separate participant links in separate authenticated contexts.
Exercise the paths you will launch
A successful POST only validates the first step. Include the complete participant and event journey in each selected scenario.
- Happy path
Create, route, invite, sign, complete, and retrieve outputs.
- Expected failures
Invalid key, unavailable/ineligible notary, rejected document, and identity failure.
- Timing and changes
Scheduled appointment, reschedule, cancel, expiration, and timezone boundaries.
- Recovery
Duplicate webhook, delayed event, expired document link, and ambiguous timeout.
Move the verified profile to production
Compare effective settings rather than assuming the same request body produces the same behavior in every account. Confirm routing, notifications, webhook subscriptions, and document release again after switching credentials.
- Use an approved low-volume production validation.
- Monitor the first completed sessions and delivery logs.
- Define who owns failed dispatch, webhook delivery, and document-processing incidents.