InitOptions
Options forProview.session.init. The dsn is passed to Proview.init instead; see Getting Started → Initialize.
| Attribute | Type | Description | Default |
|---|---|---|---|
identifier* | string | Value that can identify the proctored session in the source platform. Recommended maximum is 100 characters. Avoid spaces — Talview trims leading and trailing spaces, but use - or _ instead. | |
attendee* | Attendee | Attendee object containing candidate details. See Attendee. | |
workflow_step* | Workflow | Workflow object containing exam/workflow details. See Workflow. | |
container_id | string | The ID of the HTML element where the Proview SDK will be rendered. | |
limit_languages | [locale.languages][] | This will limit language options for users to select from the supported list | All supported languages |
language | string | Explicitly set the SDK language | Browser default if its not supported then fallback to English (en-US). |
ProviewError
The object passed to yourProview.onError handler. See the Error Reference for the full code list and handling guidance.
| Attribute | Type | Description | Default |
|---|---|---|---|
code | string | Stable identifier for the failure. See Error codes. | |
message | string | Human-readable reason for the error, for logs. | |
type | 'critical' | 'warning' | 'info' | Severity. critical means core proctoring delivery is impacted. Set per occurrence, so the same code can arrive at different severity levels. | |
validationErrors | CustomValidationError | Present only when a configuration object failed schema validation. |
CustomValidationError
A single object — not an array. The individual failures are inissues.
| Attribute | Type | Description | Default |
|---|---|---|---|
formattedMessage | string | Every validation failure rendered into one human-readable string, naming the fields that were rejected. Use this. | |
issues | unknown[] | Raw output from the SDK’s schema validation, one entry per failed field. Element shape is not part of the documented contract — opaque diagnostic detail. |
session.state
An enum with the following values.INITIALISEDONBOARDING_IN_PROGRESSMONITORING_IN_PROGRESSPAUSEDSUSPENDEDSTOPPEDCOMPLETEDTERMINATED
SessionOptions
| Attribute | Type | Description | Default |
|---|---|---|---|
identifier | string | unique session identifier from the source system. It will be the session external id in the Talview platform. |
SessionOutput
| Attribute | Type | Description | Default |
|---|---|---|---|
uuid | GUID | Reference Talview identifier for client application to track. | |
state | session.state | ||
attendee | Attendee | ||
workflow_step | Workflow | Object containing workflow information | |
identifier | string | unique session identifier from the source system. It will be the session external id in the Talview platform. |
Attendee
| Attribute | Type | Description | Default |
|---|---|---|---|
identifier* | string | unique user identifier from the source system. It will be the external id in the Talview platform. Recommended maximum is 100 characters. Avoid spaces — Talview trims leading and trailing spaces, but use - or _ instead. | |
first_name | string | ||
last_name | string | ||
middle_name | string | ||
email | string | If not passed then system will generate email based on identifier. e.g: Att0001@dnd.talview.com | |
country_code | string (3) | ISO country code | |
country | string | Country code is passed then system will auto identify the country otherwise system will identify country code from country. | |
phone | string (15) | E164 format | |
id | int | Talview unique id generated for the course |
Workflow Type Definitions
Exam Workflow
| Attribute | Type | Description | Default |
|---|---|---|---|
identifier* | string | Unique identifier for the exam from the calling application. It will be the external id in the Talview platform. Recommended maximum is 100 characters. Avoid spaces — Talview trims leading and trailing spaces, but use - or _ instead. | |
name | string | Name of the exam | If name is not passed then external id will be used. |
flow_id | int | This is the proctor session onboarding flow identifier. | if not passed then detail flow will be mapped based on project DSN |
flow_uuid | string | Proctoring configuration identifier for the provided dsn. If the workflow step is already created with a flow, this will not override it. | |
duration | int | duration of the exam in min | |
resource | [{string,string}] | Array of key value pair to persist additional info related to exam. | |
course | [Course] | ||
id | int | Talview unique id generated for the course |
Course
| Attribute | Type | Description | Default |
|---|---|---|---|
id | int | Talview unique id generated for the course | |
name | string | Name of the Course the exam is part of. | Exam workflow name |
identifier | string | Unique identifier for the course from the calling application. If not set then exam identifier will be used. | Exam workflow external id |
resource | [{string,string}] | Array of key value pair to persist additional info related to course. |
Locale
| Attribute | Type | Description | Default |
|---|---|---|---|
language | string | based on browser info | |
string | ISO 4217 currency codes | based on browser info | |
string | Timezone | based on browser info |

