REST API · v1.0 · JSON · API Key Auth

Concero Assessment
Portal API Reference

Build powerful examination workflows. Manage exams, invite candidates at scale, and retrieve detailed result analytics — all through a clean, predictable REST interface.

Explore Endpoints Authentication Guide
4
Core Endpoints
<150ms
Avg Response
99.9%
Uptime SLA
TLS 1.3
Encryption
JSON
Format
// API Reference

Endpoints

All endpoints return JSON. All requests must include a valid x-api-key header and originate from an allowlisted IP address.

Base URL https://beta-consero.ipixsolutions.net/api/v1
GET /examinations List all examinations +
Request
200 OK
401

Retrieve a clean, lightweight array of all available examinations. This endpoint does not require any parameters.

HTTP Request
GET /examinations
x-api-key:      abdbd183****************************************eb953214
Accept:         application/json
200 OK · application/json
[
  {
    "testId": 119,
    "testName": "Technology - Email Test"
  }
]
401 Unauthorized · application/json
{
  "success": false,
  "message": "Unauthorized API key."
}
POST /allocate-candidate Allocate exam to candidate +
Request Body
201 Created
500 Server Error

Allocate a single candidate to an examination natively. This automatically creates the candidate record if they are new, mapping them securely to the appropriate group.

Field Type Required Description
examination_id integer required ID of the examination
candidate_email string (email) required Email address of candidate
HTTP Request · application/json
POST /allocate-candidate
x-api-key:     abdbd183****************************************eb953214
Content-Type:  application/json

{
  "candidate_email": "arjun.mehta@company.io",
  "examination_id":  119
}
201 Created · application/json
{
  "success": true,
  "message": "Candidate allocated to examination successfully.",
  "data": {
    "candidate_email": "arjun.mehta@company.io",
    "examination_id":  119,
    "invite_id":       142,
    "invite_link":     "https://beta-consero.ipixsolutions.net/exam/start/A3bk..."
  }
}
500 Server Error · application/json
{
  "success": false,
  "message":"An error occurred during allocation.",
  "error":  "SQLSTATE[HY000]: General error: ... "
}
POST /cancel-allocation Revoke / Cancel an allocation +
Request
200 OK

Invalidate an existing allocation using its Invite ID. This prevents the candidate from starting or continuing the exam.

Field Type Required Description
invite_id integer required The ID received from allocation
HTTP Request · application/json
POST /cancel-allocation
x-api-key:     abdbd183****************************************eb953214

{
  "invite_id": 142
}
200 OK · application/json
{
  "success": true,
  "message": "Allocation cancelled successfully.",
  "data": {
    "invite_id": 142,
    "status":    "inValid"
  }
}
POST /report Fetch assessment report +
Request
200 OK

Retrieve the detailed assessment report for a candidate using their invite ID.

Field Type Required Description
inviteId integer required The ID received from allocation
HTTP Request · application/json
POST /report
x-api-key:     abdbd183****************************************eb953214

{
  "inviteId": 142
}
200 OK · application/json
{
  "inviteId": "142",
  "testId": "119",
  "testName": "Technology - Email Test",
  "email": "arjun.mehta@company.io",
  "reportURL": "https://beta-consero.ipixsolutions.net/report/142",
  "proctoringURL": "https://beta-consero.ipixsolutions.net/report/proctoring/142",
  "score": 74,
  "totalScore": 100,
  "percentage": 74.0,
  "testStartDate": "2024-07-15T09:02:14.00Z",
  "testEndDate": "2024-07-15T10:24:08.00Z",
  "status": "Pass",
  "metadata": {
    "mode_of_completion": "web"
  }
}
// Authentication

Authentication & Security

All API requests must be authenticated using your hardcoded API key through the x-api-key header. The server also enforces IP address restriction.

Authorization Header
x-api-key: abdbd183****************************************eb953214