StartExam API

Register Participants V2

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

Request Information

Scheme

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

URI Parameters

None

Body Parameters

Json.

  • 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)
  • tests - from 1 to 10 test identifiers, Guid.
  • participants - from 1 to 1000 participants to register. Each participant must contain a set of name-value pairs with personal data. Field names and validation rules can be found and changed in test settings.

Request Example

POST https://api.startexam.com/v2/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: 1143
Date: Mon, 24 Mar 2025 10:22:27 GMT

{
  "center": "mycenter",
  "validFrom": "2025-03-24T00:00:00Z",
  "validTill": "2025-04-03T23:59:59Z",
  "proctoring": true,
  "proctoringActivationParameters": [
    {
      "name": "Type",
      "value": "Offline"
    },
    {
      "name": "AuxiliaryCamera",
      "value": "true"
    }
  ],
  "tests": [
    "9d314df5-4f20-495e-8df1-9bb04203616c"
  ],
  "participants": [
    {
      "data": [
        {
          "name": "First Name",
          "value": "John"
        },
        {
          "name": "Last Name",
          "value": "Lennon"
        },
        {
          "name": "Email",
          "value": "lennon@gmail.com"
        },
        {
          "name": "My Custom Field Name",
          "value": "000000001"
        }
      ]
    },
    {
      "data": [
        {
          "name": "First Name",
          "value": "Paul"
        },
        {
          "name": "Last Name",
          "value": "McCartney"
        },
        {
          "name": "Email",
          "value": "paulmccartney@outlook.com"
        },
        {
          "name": "My Custom Field Name",
          "value": "000000002"
        }
      ]
    }
  ]
}

Date and Authorization headers are constructed in the standard way.

Value of participant data with type Image must be sent in base64 data URI scheme format.
Supported image types: image/jpeg, image/png, image/gif. Well formatted value example (red dot png image): 

data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==

Response Information

HTTP status code

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

Content-Type

Json.

Content

Identifiers of registered participants.

Use the URL mask below to construct a unique link for participant 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: 116

{
  "participantIds": [
    "bb9619c9-0c80-4383-aa82-cf01e0a05698",
    "b1efbc76-b865-4ba2-bb92-e7e8df37dcc3"
  ]
}

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

https://go.startexam.com/mycenter#participant/bb9619c9-0c80-4383-aa82-cf01e0a05698

Try Method