Open in ChatGPT
View as Markdown

Welcome to the Proctorio API

The Proctorio API enables learning platforms to seamlessly integrate online proctoring into their exam workflows. With just a few API calls, you can generate secure Candidate URLs for exam-takers, Reviewer URLs for instructors, and Live Proctor URLs for real-time monitoring.

What You Can Do

Candidate Launch — Generate a secure, time-limited URL that launches a proctored exam session for a student. Configure recording options, lockdown settings, verification requirements, and break allowances per exam.

Reviewer Launch — Generate a URL to the Proctorio Review Center where instructors can review recorded exam attempts, view flagged incidents, and access integrity reports.

Live Proctor Launch — Generate a URL for real-time proctoring, enabling a human proctor to monitor a candidate during their exam and intervene if necessary.

Quick Example

Here's a minimal Candidate Launch request:

curl -X POST https://us1.proctorapi.com/v2/candidate/launch \
  -H "api_key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "launch_url": "https://lms.example.com/exam/start",
    "exam_start": "https://lms.example.com/exam/start",
    "exam_take": "https://lms.example.com/exam/.*",
    "exam_end": "https://lms.example.com/exam/complete",
    "user_id": "student-12345",
    "exam_settings": {
      "record_video": true,
      "record_screen": true,
      "record_audio": false,
      "full_screen": 1,
      "close_tabs": true,
      "one_screen": true,
      "tabs": 1
    }
  }'

The API returns a URL that the student opens to begin their proctored session.

Next Steps

  1. Read the Authentication guide to set up your API key
  2. Review the Getting Started guide for integration patterns
  3. Explore the Candidate Launch endpoint documentation