Certiverse Live Eligibility API
Overview
The Certiverse Live Eligibility API enables Certiverse to perform real-time eligibility verification with a client or third-party system when a candidate books an exam. This eliminates the need to send and store eligibility data within Certiverse in advance, ensuring the most current eligibility status is always used.
The implementation of this API requires the use of Single Sign-On (SSO) and a unique candidate ID, which is passed to Certiverse within the SSO claim.
Authentication
Authentication is either via a token or the same username/password used in the result integration. The authentication method will be determined based on partner requirements. Credentials (token and/or username/password) are provided by the partner.
API Endpoints
1. Verify Course Availability
Endpoint: POST /exam-attempt/get-course
Headers
|
Key |
Description |
Value |
|
authorization |
Authorization Bearer token |
Bearer |
Request Parameters
|
Type |
Description |
Schema |
|
Body |
GetCourseCommand |
JSON |
GetCourseCommand Schema
|
Name |
Description |
Type |
|
examCode required |
Unique identifier assigned to course |
string |
Responses
|
HTTP Status Code |
Description |
|
200 |
Returns CourseModel containing course details |
|
400 |
Request is missing or contains invalid properties (ErrorModel) |
|
401 |
Authentication failed (ErrorModel) |
|
500 |
Internal server error (ErrorModel) |
CourseModel Schema
|
Name |
Description |
Type |
|
examCode required |
Unique identifier assigned to course |
string |
|
name required |
Exam name |
string |
2. Verify Candidate Eligibility
Endpoint: POST /exam-attempt/create
Headers
|
Key |
Description |
Value |
|
authorization |
Authorization Bearer token |
Bearer |
Request Parameters
|
Type |
Description |
Schema |
|
Body |
VerifyEligibilityCommand |
JSON |
VerifyEligibilityCommand Schema
|
Name |
Description |
Type |
|
clientCandidateId required |
Unique identifier assigned to the candidate by the client and passed to Certiverse as an SSO attribute |
string |
|
examCode required |
Exam code configured in the Certiverse booking platform |
string |
Responses
|
HTTP Status Code |
Description |
|
200 |
Returns EligibilityModel containing eligibility details |
|
400 |
Request is missing or contains invalid properties (ErrorModel) |
|
401 |
Authentication failed (ErrorModel) |
|
500 |
Internal server error (ErrorModel) |
EligibilityModel Schema
|
Name |
Description |
Type |
|
isEligible required |
true if candidate is eligible, false otherwise |
boolean |
|
eligibilityId optional |
Unique identifier for eligibility. If isEligible is true, this should always be returned to allow future calls using this ID |
string |
|
startDateTimeUtc optional |
Earliest UTC date and time when the candidate can schedule the exam. If omitted, no restriction applies. Format: yyyy-MM-dd HH:mm:ss |
datetime |
|
endDateTimeUtc optional |
Latest UTC date and time when the candidate can schedule the exam. If omitted, no restriction applies. Format: yyyy-MM-dd HH:mm:ss |
datetime |
Eligibility Flow
1. Development
- The client or partner develops and hosts an API endpoint following the specifications above.
2. Configuration
- The Certiverse Store Exam is configured with the necessary credentials, endpoint, and exam code.
3. Booking Process
- The candidate selects a Certiverse Store Exam.
- The system verifies eligibility using the client candidate ID and exam code.
- If eligibility constraints (start and end date) are returned, they will be enforced.
4. Closing Eligibility
- The eligibility ID returned in the results should be used by the client or partner system to close eligibility once the candidate has completed the process.
The Certiverse Live Eligibility API ensures real-time eligibility verification, reducing maintenance overhead and ensuring that only eligible candidates can book exams. Proper implementation of authentication, SSO, and API integration is necessary for seamless operation.