​
Resource Identifiers

SmarterProctoring uses a consistent system of resource identifiers across its API to uniquely identify various objects within the platform. Understanding these identifiers is essential for effective integration and troubleshooting.

​
Overview

Resource identifiers in SmarterProctoring follow specific patterns that indicate both the type of resource and its unique identity. These identifiers are used throughout the API for referencing, retrieving, and manipulating resources.

​
Identifier Types

SmarterProctoring uses several types of identifiers:
  • SID (System Identifier): Globally unique identifiers generated by SmarterProctoring that begin with a two-letter prefix indicating the resource type
  • API ID: Custom identifiers provided by integrating systems that must be unique within their scope
  • External ID: Identifiers from external systems that SmarterProctoring preserves for reference

​
Common SID Prefixes

Each SID begins with a two-character prefix that identifies the resource type:
PrefixResource TypeExampleDescription
ACAccountAC1ab6cf19509beac1838b2d9c5ef3e847Represents an account in the system
ADDeploymentAD8471ab6ebeac183cf195098b2d9c5ef3Represents a deployment in the system
INInstallIN3c2b1a0z9y8x7w6v5u4t3s2r1q0p9oRepresents an installation of SmarterProctoring
CUCourseCU8b2d9c5ef3e8471ab6cf19509beac183Represents a course or class in the system
USUserUS7a3b2c1d0e9f8g7h6i5j4k3l2m1n0o9Represents a user account (student, instructor, etc.)
ENEnrollmentEN5f4e3d2c1b0a9z8y7x6w5v4u3t2s1rRepresents a user’s enrollment in a course
EXExamEXa1b2c3d4e5f6g7h8i9j0k1l2m3n4o5Represents an exam or assessment
ECExam ConfigurationECa17h8i9j0k1l2m3n4o5b2c3d4e5f6gRepresents an exam configuration - this is the core details of how the exam is configured
ESExam SessionESa17h8i9j0k1l2m3n4o5b2c3d4e5f6gRepresents an exam session - this is the instance of an exam that is being taken
IIIntegrationIIf5a8dc0813f749128504e251fad9e4a3Represents an integration configuration
TSTest ServiceTS6d6011935f4646848ea4f7a29b4f61a5Represents a proctoring service type
See the Data Model page for more information about how some of the common objects are related.

​
Using Identifiers in API Requests

When making API requests, you’ll often need to reference resources using their identifiers. SmarterProctoring provides flexibility in how you can reference resources: 
// Reference by SID (most reliable)
"course": {
  "ids": {
    "sid": "CU8b2d9c5ef3e8471ab6cf19509beac183"
  }
}

// Reference by API ID (if you've assigned one)
"user": {
  "ids": {
    "api": "john-doe-123"
  }
}

// Reference by external ID (from your system)
"exam": {
  "ids": {
    "external": "exam-1"
  }
}

​
Best Practices

  • Always store SIDs returned from the API for future reference
  • When creating new resources, consider providing your own API IDs to simplify tracking
  • Use consistent ID formats within your integration
  • Include multiple ID types when available to improve matching reliability

​
Proctor Types

The following tables outline the available proctor types in the SmarterProctoring system. These are referenced using the TS prefix in their SIDs:

​
Remote Proctoring

The following table lists the available remote proctor types in the SmarterProctoring system. These are referenced using the TS prefix in their SIDs:
SIDProctor Type
TS4b894875d26194988853e490dfb9bc41Live Online Proctoring
TS9531c6b112f145018dae3cd2a9f60c4cAutomated Online Proctoring with Review
TS63dda27a6ba54c218449b934b7bb1ba8Automated Online Proctoring
TS9235d47c69d14e8aa8efb704abda9059Live Online Proctoring (via 3rd party)
TS164bcc8c5456483cab4efbed1b597aa9Automated Online Proctoring with Review (via ProctorU)
TS9bfc343debfc491bb40b7d9eee384690Automated Online Proctoring (via ProctorU)
TS6d6011935f4646848ea4f7a29b4f61a5Virtual Test Center

​
Onsite/In Person Proctoring

The following table lists the available onsite/in person proctor types in the SmarterProctoring system. These are referenced using the TS prefix in their SIDs:
SIDProctor Type
TSbff39e6956b84f6399ecaac991d9a529Institution Testing Centers
TS53e490dfb9bc414b894875d261949888Professional Testing Centers
TSa2f6350b6b9c4b92804fab5f51f5f6b6NCTA Testing Centers
TS4022bcd690754e629ea9b4f842f51c12Business Professional
TS75721782c0ec447596322e00711f0ca9Government Employee
TSf2372716b074429a8253af78afd3d51cGeneral Public
TSa7af29f68bec48feb364b9f1f543fd80Educational Administrator
TS1d268529fcdd4ec3a55be4eedd372213Educational Officer (Correctional Facility)
TSc095733eb985473ebb0f7c55b282637dInstructor (Higher Education) (Active)
TS884e9462ccf044ab961c56d8a339e5bbNotary Public
TSaa7f6ef6f6f948ff8d48777eba7e99a5Military Personnel
TSb492aa08991647c2b6a5beb2347bc3a7Education Professional
TS5cf7d6a3a29c46deadf5659ba8ba9d39Clergy (Temple, Synagogue, Mosque or Church)
TS62e5c5ff86834c1d9f49249697d94d35Instructor (K-12) (Inactive)
TSde44f39d587d4acc8d6c3fc8a8aa7282Testing Administrator (College, University or Private Testing Service)
TSc93c23e553ba4e2f9758e3f0649b667bInstructor as Proctor
TS346fbe6cbb27420abab2dfae7042d0d3Employee (Disability Resource Center)
TS7c3752922df64d5ea40f58189327bc85Law Enforcement Officer (Sergeant, Lieutenant or Captain Only)
TSd472cf390f27476e90e0eb0ee7409eefHuman Resources Officer
TS089e18d8e6594edcbe9fe55cab8ca631Member of the Court System
TS6885ba69fd2e4e0d8ef34620add4f2aeEducational Officer (Military Installation)
TS87ac10b2e9a7425f8451598306496ab8Instructor (K-12) (Active)
TS5553fa14b62548c5951f617a6412c5bcMilitary Base Testing Center
TSf8cc28ebd2e6451dbe888ff0a0ca8837High School Testing Center
TSa8c21e75eff0434bb42cd10909d169a9Librarian (Public Library)
TS0e3bd6f03e37469a94a58c223826ab64Professional Education Center

​
Permitted Items

The following table lists the permitted items that can be used when configuring an exam.
IDDescription
bathroomBreakBathroom break
calculatorCalculator
dictionaryDictionary
earplugsEarplugs
formulaSheetFormula sheet
notesNotes
textbookTextbook
websitesWebsites

​
Modality Options

The following table lists the modality options that can be used when configuring an exam.
IDDescription
recordScreenRecord the screen
recordWebcamRecord the webcam
recordAudioRecord the audio
forceFullScreenForce full screen
onlyOneScreenOnly one screen
disableNewTabsDisable new tabs
closeOpenTabsClose open tabs
disablePrintingDisable printing
disableClipboardDisable clipboard
disableRightClickDisable right click
verifyIdVerify ID
roomScanRoom scan