---
title: "Keycode"
slug: "keycode"
tags: ["scheduler", "admin", "candidate", "ReadSpeaker"]
updated: 2026-05-28T11:22:18Z
published: 2026-05-28T11:22:18Z
---

> ## Documentation Index
> Fetch the complete documentation index at: https://help.cirrusassessment.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Keycode

***For on-site exams, each candidate can be given a paper slip with a unique, single-use keycode to access their exam in Cirrus.***

Keycodes are a single-use, easy-to-enter login method that gives candidates direct access to their exam. After a candidate logs in with a keycode, Cirrus validates the login and redirects them directly to the exam. The candidate dashboard is bypassed.

## Keycode login

![keycode-username-keycode.jpg](https://cdn.document360.io/cdfc20c8-6721-4154-b0a1-9f49f139d107/Images/Documentation/keycode-username-keycode.jpg)

              Candidate will skip Candidate Dashboard

              

The candidate enters the exam introduction page directly, bypassing the candidate dashboard.

### Key benefits for test centres

In test centres, candidates often receive login details on a paper slip. This process must be simple and provide access only to the upcoming exam.

The Keycode feature is designed for exactly this purpose.

              Keycode slips replace Print login details

              

Keycode replaces **Print login details**. It is a simpler solution for the same scenarios and does not have the disadvantage of automatically resetting candidate passwords.

### How to set up and use keycode

#### Step 1: activate in global settings

By default, the Keycode feature is disabled. A System Administrator must first activate it in Global Settings.

Go to **Admin → Global Settings → General → Keycode**.

**Keycode with or without username**

A keycode can be used alone or combined with the candidate's username for an extra layer of security.

**Require username** can only be enabled if **Use Keycode** is also enabled.

![Screenshot 2022-02-04 at 16.56.29.png](https://cdn.document360.io/cdfc20c8-6721-4154-b0a1-9f49f139d107/Images/Documentation/Screenshot%202022-02-04%20at%2016.56.29.png)

#### Step 2: Schedule an exam with keycode

Once activated, the keycode setting on schedule level can be enabled or disabled. It is enabled by default but can be overridden when adding a new schedule (in the **Add new schedule** dialog) or when editing a draft schedule (**Edit schedule settings**).

This replaces the standard username/password login for candidates with the keycode.

![Screenshot 2022-03-31 at 20.14.45.png](https://cdn.document360.io/cdfc20c8-6721-4154-b0a1-9f49f139d107/Images/Documentation/Screenshot%202022-03-31%20at%2020.14.45.png)

              Always assign an invigilator to distribute the keycodes

              

Keycode slips must be printed and distributed to candidates by an invigilator. Ensure an invigilator is assigned to facilitate this.

#### Step 3: print keycode slips

As an invigilator, go to the Invigilation dashboard (**Delivering → Invigilation → Open schedule**) and print all keycodes before the exam starts.

Once printed, distribute the keycode slips to candidates. Each slip is one page per candidate.

              Keycode slips replace Print login details

              

Keycode replaces **Print login details**. It is a simpler solution for the same scenarios and does not have the disadvantage of automatically resetting candidate passwords.

![Screenshot 2022-02-10 at 13.04.31.png](https://cdn.document360.io/cdfc20c8-6721-4154-b0a1-9f49f139d107/Images/Documentation/Screenshot%202022-02-10%20at%2013.04.31.png)

#### Example keycode slip

Each keycode slip contains:

- Introductory text
- URL + /#keycode
- Username (if enabled in Admin settings)
- Keycode
- Assessment name
- If PIN is enabled: "At exam time you will be handed a PIN which you will need in addition to the keycode."
- Closing note: "In the event that you also have a regular username/password please note that it will be disabled during this exam."

**Example (with PIN enabled):**

> Welcome John Smith
> 
> 
> To enter this exam please use the URL and Keycode shown here:
> 
> 
> URL: https://demo-org.cirrusplatform/#keycode Username: jsmith Keycode: Q23BC6 Assessment: Advanced Question Types
> 
> 
> At exam time you will be handed a PIN which you will need in addition to the keycode.
> 
> 
> In the event that you also have a regular username/password please note that it will be disabled during this exam.

#### Step 4: candidates using keycode

Candidates access the Keycode login page using the URL on their slip, distributed by the invigilator before the exam starts.

Example link: `https://demo-org.cirrusplatform/#keycode`

              Candidate will skip candidate dashboard

              

The candidate enters the exam introduction page directly, bypassing the normal candidate dashboard.

#### Regular login screen with keycode

A candidate who arrives at the standard login page can also access the exam.

When Keycode is activated in Global Settings, the regular login screen includes an extra prompt:

"Click here to login using an 8-character keycode for an exam (review)"

This link takes candidates to the Keycode login page.

![Screenshot 2022-02-04 at 17.00.13.png](https://cdn.document360.io/cdfc20c8-6721-4154-b0a1-9f49f139d107/Images/Documentation/Screenshot%202022-02-04%20at%2017.00.13.png)

#### Roadmap: review sessions

Keycode support for Review Sessions is planned for a future release.

See our [Release Notes](https://help.cirrusassessment.com/docs/release-policy) and subscribe to updates via the [Status Page](https://status.cirrusplatform.com/).
