Documentation

Corrections, revocation and expiry

What each state does to the public record, and what it does not.

The states

State Resolves publicly? Means
PENDING No Issued, not published. 404s like a code that does not exist
UNDER_REVIEW No Waiting for approval. Also 404s
PUBLISHED Yes Live and valid
EXPIRED Yes, carrying its status Was valid; the validity period ended
SUSPENDED Yes, carrying its status Temporarily withdrawn
REVOKED Yes, carrying its status Withdrawn for good

Unpublished credentials 404 with the same message as a nonexistent code. Saying "this exists but is in review" would leak that somebody is about to receive something.

Revoked, suspended and expired credentials still resolve. Deleting the record would be the naive choice and it breaks every downstream verifier: a consumer that gets a 404 cannot tell "withdrawn" from "never existed" from "their server is down".

Corrections

A correction issues a new credential that replaces the original, with both linked. The original is not edited.

What the public record said was issued stays said. A correction adds to the history rather than rewriting it, which is the difference between a correction and a cover-up — and an auditor can tell.

Revoking

Revocation takes effect immediately: the check page, the Open Badges assertion and the revocation list all change in the same request, and every verifier watching that credential is notified at once rather than on a later sweep.