Skip to main content
POST
Register candidates on an exam

Authorizations

X-API-Key
string
header
required

Your institute's API key, vak_eval_ followed by 48 hex characters. An institute admin creates keys in the dashboard under Settings -> Integrations -> API keys.

Headers

Idempotency-Key
string

Optional. Any unique string of 1-255 printable ASCII characters (a UUID works). Retrying with the same key within 48 hours replays the first response with Idempotent-Replayed: true.

Maximum string length: 255
Example:

"exam-cbse-sci-10a-2026-10-14"

Path Parameters

examId
string<uuid>
required

Exam id (UUID).

Body

application/json
candidates
object[]
candidate_ids
string[]

Response

OK

The response is of type object.