Documentation

Programmes and ID formats

Credential groups, expiry policy, behaviour switches and how IDs are built.

A credential group is the programme. It holds the designs, the expiry policy, the ID format and the behaviour switches.

Behaviour switches

Switch What it does
requireReview Credentials land in review and somebody else publishes them
autoPublish Publish as soon as it is issued, in one step
emailOnPublish Email the recipient. On by default
remindAfterDays Chase recipients who have not opened or accepted
privateCheckLink The check link carries an unguessable token instead of the printed ID
allowChangeRequests Recipients can report a mistake from the check page

privateCheckLink, specifically

Credential IDs run in sequence. Without this, somebody holding one can count upwards and read every other recipient's name and programme. With it, the ID is still printed but stops being a lookup key — only the token resolves.

ID format

An ID is built from your prefix, the programme's code and a sequence: ACME-MERN-NOV26-0007. It reads as something rather than as a random string, and the sequence is per-tenant and atomic, so an ID is never reused even under concurrent issuing.

Programme codes are not editable once used. The code is inside every ID already printed, and changing it would make an issued credential's ID disagree with how the next one is built.

Expiry

Set a validity period per programme, or a date per credential. An expired credential still resolves, carrying its status — deleting it would break every downstream verifier that has recorded it.