SDK Test Suite #
The Test Suite is an interactive tool for testing your Veriform integration before going live.
Features #
The Test Suite provides:
- API Key Selection — Select from your account keys or enter manually
- Real-time SDK Status — Monitor WebSocket connection, API key validation
- Live Parameters — View SDK configuration and recording metadata
- Sample Form — Pre-filled form for quick testing
- Activity Log — Detailed log of SDK events
- Database Records — View recent certificates from your account
- Embed Code Generator — Copy-paste ready code for your site
Getting Started #
1. Sign In (Optional) #
Sign in with Google, GitHub, or Microsoft to load your API keys automatically. Or enter a key manually.
2. Select an API Key #
Choose a key from the dropdown or paste one manually:
- 🟡 TEST keys (
test_xxx) — Free testing, certificates expire in 7 days - 🔴 PROD keys (
prod_xxx) — Production use, counts against your plan
3. Initialize the SDK #
Click Initialize SDK to load the SDK with your selected key. Watch the status panel:
| Status | Meaning |
|---|---|
| SDK Loaded | Script downloaded successfully |
| WebSocket | Real-time connection to server |
| API Key Valid | Server confirmed your key |
| Recording ID | Unique ID for this session |
4. Submit the Form #
Fill out the sample form and click Submit & Generate Certificate. The SDK will:
- Save the recording to storage
- Queue the certificate for processing
- Generate a unique certificate URL
5. View the Certificate #
Click the certificate link to view:
- Certificate Tab — Metadata (IP, location, browser, timestamps)
- Event Log — Timeline of all user interactions
- Session Replay — Full video playback of the session
Status Indicators #
SDK Status Badge #
| Badge | Meaning |
|---|---|
| Not Initialized | SDK not yet loaded |
| Initializing | Loading and connecting |
| Ready | Connected and recording |
| Key Invalid | API key rejected |
| Error | Connection failed |
Connection Status Cards #
| Card | Success | Failure |
|---|---|---|
| SDK Loaded | Script loaded | Script failed to load |
| WebSocket | Connected to server | Connection timeout |
| API Key Valid | Server accepted key | Key rejected or expired |
SDK Embed Code #
The Test Suite generates ready-to-use embed code:
<!-- Veriform SDK -->
<script
src="https://cert.veriform.co/sdk.min.js"
data-key="test_xxxxxxxxxxxxxx"
defer
></script>
Click Copy to copy the code with your selected API key.
SDK Parameters Panel #
View the active SDK configuration:
{
"server": "https://cert.veriform.co",
"apiKey": "test_xxxxxxxxxxxx...",
"keyType": "test",
"recordingId": "pub_abc123...",
"sdkReady": true,
"apiKeyValid": true,
"sessionStartTime": "2025-11-28T12:00:00.000Z",
"currentUrl": "https://veriform.co/test.html"
}
Activity Log #
The log shows all SDK events in real-time:
[12:00:00] Logged in as user@example.com
[12:00:01] Loaded 3 API key(s)
[12:00:05] Selected key: test_abc123...
[12:00:06] Initializing SDK...
[12:00:06] SDK script loaded
[12:00:07] SDK ready, WebSocket connected
[12:00:07] Recording ID: pub_xyz789...
[12:00:08] API key validated
[12:00:30] Form submitted, saving recording...
[12:00:31] Recording saved to S3
[12:00:31] Certificate generated: pub_xyz789...
Database Records #
If signed in, view your recent certificates:
| Cert Key | Status | Created |
|---|---|---|
pub_abc123... |
Active | 11/28/2025, 12:00:00 PM |
pub_def456... |
Claimed | 11/27/2025, 3:30:00 PM |
- Active — Certificate available, not yet used in a claim
- Claimed — Certificate attached to a lead dispute
Troubleshooting #
SDK Not Connecting #
- Check the Activity Log for errors
- Verify the API key is correct and active
- Check browser console for CORS or network errors
- Try refreshing and re-initializing
API Key Invalid #
- Verify the key in your Dashboard
- Check if the key is active (not disabled)
- Ensure you’re using the correct environment (test vs prod)
- Check if your account is in good standing
Certificate Not Appearing in Database #
- Wait 5-10 seconds and click Refresh
- The DbTask service processes certificates every 2 seconds
- Check if you’re signed in with the correct account
- Only generators can view certificates (not buyers)
Form Submit Not Working #
- Ensure SDK status shows “Ready”
- Check the Activity Log for errors
- Try clicking Reset and submitting again
Using Test Suite for Debugging #
The Test Suite is ideal for:
- Validating API Keys — Before deploying, verify your key works
- Testing SDK Behavior — See exactly what the SDK captures
- Debugging Integration — Compare your site’s behavior to the test suite
- Demoing to Stakeholders — Show the certificate generation flow
- Verifying Database Writes — Confirm certificates are being stored
Next Steps #
- Quickstart Guide — Integrate the SDK into your site
- SDK Reference — Complete API documentation
- TCPA Consent Handling — Best practices for consent capture