JenkinWoo/sheeridVerify

What it does

sheeridVerify is a Node.js project for walking through SheerID verification flows in a teaching or research context. It queries verification status, opens a browser form to fill student information when required, and uploads an existing PNG, JPEG or PDF document when the flow reaches the document step. It also ships a local web workbench that queues jobs, controls concurrency, stops and resumes tasks, and polls results.

The project does not generate or alter proof documents, and interactive human verification is left to the user in the browser. The README states that real platforms should only be used with authorization and that the project has no affiliation with SheerID or any school.

Quick start

Node.js 22.15 or newer and npm are required. Clone the repository, install dependencies and the browser runtime, then create a local config:

git clone https://github.com/JenkinWoo/sheeridVerify.git
cd sheeridVerify
npm ci
npm run browser:install
cp -n config/sheerid.example.json config/sheerid.local.json

On Windows PowerShell, use Copy-Item config/sheerid.example.json config/sheerid.local.json instead of cp. Edit config/sheerid.local.json to set the authorized country, school, data.organization.emailDomain and document source; the file must be strict JSON without comments or trailing commas. Then start the workbench:

npm run web

Open http://127.0.0.1:8787, enter the verification link, name, birth date, optional proxy and access password, and add the job to the queue. The default local password is JenkinWoo; change it with ONE_WEB_PASSWORD before exposing the service and put it behind an HTTPS entry point.

For command-line use, npm run status only queries state, npm start opens and fills the form without submitting, and npm run submit -- --file <path> or --url <address> handles the document step. A minimal config is shown in config/documents.example.json; document.path and document.url are mutually exclusive, and the document must be non-empty PNG, JPEG or PDF under 20 MiB.

Usage constraints

A desktop display is needed on Linux when the interactive browser is used; the full deployment and environment variable reference is in the deployment guide. Public deployments must change the default password and serve over HTTPS. Queue state and history live only in service memory, so restarting the service drops pending and running jobs. Submitted reviews keep occupying a task slot until they succeed, fail or are stopped.

The tool supports HTTP, HTTPS and SOCKS5 proxies with optional credentials. When no proxy is configured it falls back to system proxy settings, but PAC scripts and proxy exclusion lists are unsupported.

HotRepo's take

The repository appeared on HotRepo's new-project list on 2026-11-06, recording 101 stars and 81 forks in a growth window starting that morning. That is a single-snapshot record rather than a trend, so it shows early attention but no sustained ranking history. The unusually high fork-to-star ratio is worth noting for a repository this young.