The module gives every client a short, one-time-visible PIN they can read aloud, and gives staff a matching set of tools to check it, or to identify a client from the PIN alone, without ever seeing the PIN in reverse.
PINs are stored as a one-way digest and are never recoverable, even from the database.

We will guide you step by step through the whole installation and configuration process.

The content of the package to upload should look like this.

The file is located in 'modules/addons/ServerMonitoring/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → 'My Products'.

Log in to your WHMCS admin area. Go to 'System Settings' → 'Addon Modules'. Afterwards, find 'Server Monitoring' and press the 'Activate' button.

To do so, click on the 'Configure' button, tick 'Full Administrator' and press 'Save Changes'.

You can access your module under 'Addons' → 'Support PIN'.
Note: Expired PINs are swept automatically by the standard WHMCS daily cron task — no additional cron command needs to be configured for this module.

In this guide, we will walk you through every section and option of the module in detail.

• Active - PINs currently valid and not yet used up.

• Used - PINs that have reached their configured verification limit.

• Expired - PINs past their expiration time.

• Revoked - PINs manually revoked by staff.

Each counter has its own 'View PINs' button, which filters the table below to just that status.

• Client ID - the client the PIN belongs to, linked to their profile.

• Status - "Active", "Used", "Expired" or "Revoked".

• Length - how many digits the PIN has.

• Single Use - whether the PIN is invalidated the first time it is used.

• Created At - when the PIN was generated.

• Expires At - when the PIN will stop being valid.

• Used At - when the PIN was verified by staff, if it has been.

Use the trash icon on a row to 'Revoke PIN' on that single entry.

• PIN Length - the number of digits generated for each new PIN.
• PIN Expiration Time (Hours) - how many hours after generation a PIN remains valid.

• Allow Multiple Active PINs - off by default, which makes a PIN single-use: generating a new one deactivates any previous active PIN.
  Turned on, a PIN can be verified more than once and several can be active for a client at the same time.

• Expire PIN After X Uses - marks a PIN used/expired after this many successful verifications. The default, 1, makes every PIN single-use regardless of the toggle above; 0 removes the cap entirely.
  This setting and "Allow Multiple Active PINs" are independent - the toggle controls whether a new PIN revokes an older one, this field controls how many times any one PIN can be verified before it's spent.

• Require PIN Verification For Client Access - if enabled, staff must verify a client's Support PIN before that client's data can be opened at all.

• Deny Admin Access After PIN Expiration - if enabled, access granted by a verified PIN is revoked again once that PIN expires.

• Hide Full PIN - if enabled, the full PIN value is masked wherever it would otherwise be displayed in the admin area.

• Enable Generate PIN Button - shows or hides the 'Generate Support PIN' button in the client area. When disabled, clients cannot generate new PINs themselves.

Entering a matching PIN here redirects straight to that client's profile - unlike the Client Summary verify field, this path does not consume the PIN's use count.

Unlike the Home Widget verify field, a successful verification here does count against the PIN's use limit.

• is added to the bundle of maximum of 5 active PINs (option: "Allow Multiple Active PINs" is On), or
• replaces the current PIN (option: "Allow Multiple Active PINs" is Off).

For detailed guidance on using this tool, check its dedicated article, which is available here.

Staff only ever need to verify a PIN a client reads aloud, not to read it back themselves - the value is a one-way hash regardless and can never actually be redisplayed.

Combined with "Deny Admin Access After PIN Expiration", staff will need to re-verify the client for every new support interaction.

Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.

Check 'Settings' → 'Client Area' → 'Enable Generate PIN Button' is turned on.

This happens when 'Require PIN Verification For Client Access' is enabled and the previously verified PIN has expired. Ask the client to read out their current PIN again, or generate a new one, and verify it from the Client Summary panel or the module's Dashboard.

This is expected with the default policy: 'Expire PIN After X Uses' is 1 out of the box, so a PIN is spent after its first successful verification. Raise that value (or set it to 0 for no limit) in 'Settings' → 'PIN Lifecycle' if clients need to be verified more than once per PIN.