StartExam API

Register Employees

Method registers employees for a test and returns identifiers that can be used to start the test.

Request Information

Scheme

POST https://api.startexam.com/v2/employees-participants

URI Parameters

None

Body Parameters

Json with the RegisterParticipantsQuery, see details and example below.

  • center - center unique name. The value can be retrieved from the center details page.
  • validFrom - session link activation time, UTC, ISO 8601.
  • validTill - session link expiration time, UTC, ISO 8601.
  • proctoring - enable proctoring (applicable only for accounts with enabled proctoring)
  • proctoringActivationParameters - proctoring parameters (applicable only with enabled proctoring)
  • doNotCreateIfExist - do not create new registration if employee has been already registered for center and test
  • tests - from 1 to 10 test identifiers, Guid.
  • employees - from 1 to 500 employees identifiers.

Request Example

POST https://api.startexam.com/v2/employees-participants HTTP/1.1
Host: api.startexam.com
Accept: application/json; charset=utf-8
Authorization: SharedKey 99:f52JP7GQd0xqrBzMO1NWTNVGzLENymgdUXu/Ie++NX4=
Content-Type: application/json; charset=utf-8
Content-Length: 518
Date: Wed, 06 Aug 2025 12:06:03 GMT

{
  "center": "mycenter",
  "validFrom": "2025-08-06T00:00:00Z",
  "validTill": "2025-08-16T23:59:59Z",
  "proctoring": true,
  "proctoringActivationParameters": [
    {
      "name": "Type",
      "value": "Offline"
    },
    {
      "name": "AuxiliaryCamera",
      "value": "true"
    }
  ],
  "doNotCreateIfExist": false,
  "tests": [
    "d6c317f1-8268-41d0-b5b1-46046f9824b1"
  ],
  "employees": [
    {
      "id": "willis74"
    },
    {
      "id": "knightly32"
    },
    {
      "id": "covey77"
    }
  ]
}

Date and Authorization headers are constructed in the standard way.

Response Information

HTTP status code

200 OK, 400 Bad Request, etc. according the response processing guide.

Content-Type

Json.

Content

Identifiers of registered participants (sessions for employees).

Use the URL mask below to construct a unique link for employee and redirect him to his exam:

https://go.startexam.com/{center}#participant/{id}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 160

{
  "participantIds": [
    "cba3b57e-1ed2-4445-95ec-b6a1c1aacc93",
    "ca6929d3-8823-470c-b890-7acea6cea8ef",
    "0e90fd4b-af40-4df6-972c-5e7de9824847"
  ]
}

To redirect the first participant (willis74) to the assessment you can use URL:

https://go.startexam.com/mycenter#participant/cba3b57e-1ed2-4445-95ec-b6a1c1aacc93

Try Method