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:

Prefix	Resource Type	Example	Description
`AC`	Account	`AC1ab6cf19509beac1838b2d9c5ef3e847`	Represents an account in the system
`AD`	Deployment	`AD8471ab6ebeac183cf195098b2d9c5ef3`	Represents a deployment in the system
`IN`	Install	`IN3c2b1a0z9y8x7w6v5u4t3s2r1q0p9o`	Represents an installation of SmarterProctoring
`CU`	Course	`CU8b2d9c5ef3e8471ab6cf19509beac183`	Represents a course or class in the system
`US`	User	`US7a3b2c1d0e9f8g7h6i5j4k3l2m1n0o9`	Represents a user account (student, instructor, etc.)
`EN`	Enrollment	`EN5f4e3d2c1b0a9z8y7x6w5v4u3t2s1r`	Represents a user’s enrollment in a course
`EX`	Exam	`EXa1b2c3d4e5f6g7h8i9j0k1l2m3n4o5`	Represents an exam or assessment
`EC`	Exam Configuration	`ECa17h8i9j0k1l2m3n4o5b2c3d4e5f6g`	Represents an exam configuration - this is the core details of how the exam is configured
`ES`	Exam Session	`ESa17h8i9j0k1l2m3n4o5b2c3d4e5f6g`	Represents an exam session - this is the instance of an exam that is being taken
`II`	Integration	`IIf5a8dc0813f749128504e251fad9e4a3`	Represents an integration configuration
`TS`	Test Service	`TS6d6011935f4646848ea4f7a29b4f61a5`	Represents 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 Location Types

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

SID	Type	Key
LT3ddbab9b6a1f40c385e7efc015967034	Classroom / Lecture Hall	in-person
LT1fef2992eda74744a432dc963c9877ed	Coffee Shop	in-person
LTe1f2452810d34266864938b4cc8c8f0e	Computer Lab	in-person
LT79a424a742534a7689bb5f0803626bc6	Library	in-person
LT5e18eda572134379939dd2ef766ebf43	Office Building	in-person
LT7068df1ade4846abb0e7612c51d7d141	Testing Center	in-person
LT07b8055c8a9c457c82c58b235a05d53b	Online	online

Any remote proctoring will use the Online type and any testing center wil use the Testing Center type. These are the most used types.

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:

SID	Proctor Type
`TS4b894875d26194988853e490dfb9bc41`	Live Online Proctoring
`TS9531c6b112f145018dae3cd2a9f60c4c`	Automated Online Proctoring with Review
`TS63dda27a6ba54c218449b934b7bb1ba8`	Automated Online Proctoring
`TS9235d47c69d14e8aa8efb704abda9059`	Live Online Proctoring (via 3rd party)
`TS164bcc8c5456483cab4efbed1b597aa9`	Automated Online Proctoring with Review (via ProctorU)
`TS9bfc343debfc491bb40b7d9eee384690`	Automated Online Proctoring (via ProctorU)
`TS6d6011935f4646848ea4f7a29b4f61a5`	Virtual Test Center

Remote Proctoring Locations

The following table lists the standard location sids that can be used for interacting with remote sessions.

SID	Proctor Type
`PLfbb1cd14abf644afa3f0198d0bb36340`	Live
`PL4faca934a231436dbb58e2de6cbf6fb8`	Record & Review (48 Hour)
`PL93fc179ec44448838bd545f7ecc4f11b`	Automated

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:

SID	Proctor Type
`TSbff39e6956b84f6399ecaac991d9a529`	Institution Testing Centers
`TS53e490dfb9bc414b894875d261949888`	Professional Testing Centers
`TSa2f6350b6b9c4b92804fab5f51f5f6b6`	NCTA Testing Centers
`TS4022bcd690754e629ea9b4f842f51c12`	Business Professional
`TS75721782c0ec447596322e00711f0ca9`	Government Employee
`TSf2372716b074429a8253af78afd3d51c`	General Public
`TSa7af29f68bec48feb364b9f1f543fd80`	Educational Administrator
`TS1d268529fcdd4ec3a55be4eedd372213`	Educational Officer (Correctional Facility)
`TSc095733eb985473ebb0f7c55b282637d`	Instructor (Higher Education) (Active)
`TS884e9462ccf044ab961c56d8a339e5bb`	Notary Public
`TSaa7f6ef6f6f948ff8d48777eba7e99a5`	Military Personnel
`TSb492aa08991647c2b6a5beb2347bc3a7`	Education Professional
`TS5cf7d6a3a29c46deadf5659ba8ba9d39`	Clergy (Temple, Synagogue, Mosque or Church)
`TS62e5c5ff86834c1d9f49249697d94d35`	Instructor (K-12) (Inactive)
`TSde44f39d587d4acc8d6c3fc8a8aa7282`	Testing Administrator (College, University or Private Testing Service)
`TSc93c23e553ba4e2f9758e3f0649b667b`	Instructor as Proctor
`TS346fbe6cbb27420abab2dfae7042d0d3`	Employee (Disability Resource Center)
`TS7c3752922df64d5ea40f58189327bc85`	Law Enforcement Officer (Sergeant, Lieutenant or Captain Only)
`TSd472cf390f27476e90e0eb0ee7409eef`	Human Resources Officer
`TS089e18d8e6594edcbe9fe55cab8ca631`	Member of the Court System
`TS6885ba69fd2e4e0d8ef34620add4f2ae`	Educational Officer (Military Installation)
`TS87ac10b2e9a7425f8451598306496ab8`	Instructor (K-12) (Active)
`TS5553fa14b62548c5951f617a6412c5bc`	Military Base Testing Center
`TSf8cc28ebd2e6451dbe888ff0a0ca8837`	High School Testing Center
`TSa8c21e75eff0434bb42cd10909d169a9`	Librarian (Public Library)
`TS0e3bd6f03e37469a94a58c223826ab64`	Professional Education Center

Permitted Items

The following table lists the permitted items that can be used when configuring an exam.

ID	Description
`bathroomBreak`	Bathroom break
`calculator`	Calculator
`dictionary`	Dictionary
`earplugs`	Earplugs
`formulaSheet`	Formula sheet
`notes`	Notes
`textbook`	Textbook
`websites`	Websites

Modality Options

The following table lists the modality options that can be used when configuring an exam.

ID	Description
`recordScreen`	Record the screen
`recordWebcam`	Record the webcam
`recordAudio`	Record the audio
`forceFullScreen`	Force full screen
`onlyOneScreen`	Only one screen
`disableNewTabs`	Disable new tabs
`closeOpenTabs`	Close open tabs
`disablePrinting`	Disable printing
`disableClipboard`	Disable clipboard
`disableRightClick`	Disable right click
`verifyId`	Verify ID
`roomScan`	Room scan

Getting Started

Common Integrations

Endpoints

Resource Identifiers

Resource Identifiers

Overview

Identifier Types

Common SID Prefixes

Using Identifiers in API Requests

Best Practices

Proctor Location Types

Proctor Types

Remote Proctoring

Remote Proctoring Locations

Onsite/In Person Proctoring

Permitted Items

Modality Options

​Resource Identifiers

​Overview

​Identifier Types

​Common SID Prefixes

​Using Identifiers in API Requests

​Best Practices

​Proctor Location Types

​Proctor Types

​Remote Proctoring

​Remote Proctoring Locations

​Onsite/In Person Proctoring

​Permitted Items

​Modality Options

Resource Identifiers

Overview

Identifier Types

Common SID Prefixes

Using Identifiers in API Requests

Best Practices

Proctor Location Types

Proctor Types

Remote Proctoring

Remote Proctoring Locations

Onsite/In Person Proctoring

Permitted Items

Modality Options