Overview
What Proctor is, the correlationId spine that ties preflight to session, and how to pick your integration path.
Proctor is a browser SDK plus an API for instrumenting integrity signals in your own test runner. The SDK owns its Worker, an IndexedDB event queue, media uploaders, a heartbeat, and a clean-end drain path, then ships typed events to your dashboard with idempotent IDs.
The correlationId spine
The whole system is tied together by one id — the customer's correlationId. Your LMS issues one id per exam attempt and passes it to both the preflight wizard and the runtime SDK. The server stitches preflight and session into a single record, and the dashboard shows them together at /sessions/<correlationId>.
Your host page generates correlationId
│
├──────────────┬───────────────────┐
▼ ▼ ▼
Preflight wizard Runtime SDK Server API
(same id) (same id) (look up by id)Client integration
The candidate-facing UI is the only framework-coupled surface — the backend, ingest, webhooks, and dashboard are the same however you integrate. Every view layer drives the same engine (the preflight SystemCheck and runtime ProctoringClient in the SDK), so preset, policy, and events are identical. The Vue wrapper and raw SDK ship today; only React remains in progress.
@a4anthony/proctorkit-vueDrop-in <ProctoredAssessment> + preflight wizard for Vue 3.
@a4anthony/proctorkit-reactSame components + hooks over the shared engine.
@a4anthony/proctorkit-sdkBring your own UI — drive SystemCheck + ProctoringClient directly. Angular, Svelte, Solid, plain JS.
See Choose your integration for the per-path setup, then use the raw SDK guide for the lower-level lifecycle and recovery contract.
Pick your path
Install the SDK, mount the Vue wrapper, pick a preset, ship your first session.
Browser/device checks, face-photo verification, and candidate intake before the test.
Read outcomes and manage attempts from your backend with a secret key.
Connect Codex, Claude Code, Cursor, VS Code, and other MCP clients to Proctor docs and the API reference.