SDK Test Suite Guide

SDK Test Suite #

The Test Suite is an interactive tool for testing your Veriform integration before going live.

→ Open Test Suite


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:

  1. Save the recording to storage
  2. Queue the certificate for processing
  3. 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 #

  1. Check the Activity Log for errors
  2. Verify the API key is correct and active
  3. Check browser console for CORS or network errors
  4. Try refreshing and re-initializing

API Key Invalid #

  1. Verify the key in your Dashboard
  2. Check if the key is active (not disabled)
  3. Ensure you’re using the correct environment (test vs prod)
  4. Check if your account is in good standing

Certificate Not Appearing in Database #

  1. Wait 5-10 seconds and click Refresh
  2. The DbTask service processes certificates every 2 seconds
  3. Check if you’re signed in with the correct account
  4. Only generators can view certificates (not buyers)

Form Submit Not Working #

  1. Ensure SDK status shows “Ready”
  2. Check the Activity Log for errors
  3. Try clicking Reset and submitting again

Using Test Suite for Debugging #

The Test Suite is ideal for:

  1. Validating API Keys — Before deploying, verify your key works
  2. Testing SDK Behavior — See exactly what the SDK captures
  3. Debugging Integration — Compare your site’s behavior to the test suite
  4. Demoing to Stakeholders — Show the certificate generation flow
  5. Verifying Database Writes — Confirm certificates are being stored

Next Steps #