/source/ · Markdown + JSON Schema · CC-BY-4.0

spec

v1.0.0

The normative specification source. Markdown plus the JSON Schema and canonical test vectors referenced from the appendices. CC-BY-4.0.

published March 2026commit 8af4c92d62 files · 218 KB

About this artefact

spec contains the source for the OpenReceipt normative specification — the same document rendered at /spec/. Top-level Markdown files cover §1–§8, the appendices, and the IANA considerations. The CC-BY-4.0 licence makes the spec freely quotable, forkable, and translatable; only the trademark SignedReceipts compatible badge is reserved.

Alongside the prose, the tarball ships schema/openreceipt-1.0.schema.json (the normative JSON Schema referenced from §4 and Appendix A) and vectors/canonicalisation/ (the JCS round-trip vectors that conformance harnesses pin against). The published /spec/ page is built deterministically from these sources at every ratification and the rendered HTML is diffed against the previous release.

Manifest

No tarball is published yet. Below is a manifest of the source files (SHA-256 fingerprints, file count, commit).
PathSizeSHA-256
spec.md84 KB4bd4cf0c146a1ee8eb6bd98676d38b560a1fd1453bb517a287e75816a6c55f1f
schema/openreceipt-1.0.schema.json11 KB826ed8701380883fa7b160adc53fd63cc55d5fc7a8b8c6a4fcef8c511fc84cfc
vectors/canonicalisation/26 files · 38 KBb5f4bea08588c6b7d4aa56c74d4dd35b5020d0beda95b932a43dac585eaf3781
appendix-a.md9.4 KB2cc023419465223aa2706e94f4f7cfd3f3a530c30ff1d980dec0f11920620f84
appendix-b.md12 KBdb7de8995ec6c3403309dfb8702d82c772fff1d0eef9b8f34586817b0e84b730
62 files · 218 KB · commit 8af4c92d

Quick start

shell 
# The downloadable spec source tarball is being prepared and is not
# yet published. The normative text is browsable at /spec/ in the
# meantime.
shell 
# Validate a receipt against the normative schema
ajv validate -s schema/openreceipt-1.0.schema.json -d ./my-receipt.json

# Render the spec locally (Pandoc 3+)
pandoc spec.md -o spec.html --metadata title='OpenReceipt'

Issues / questions

Bug reports, patches, and security advisories all go to the CloakAPI open-source inbox.

open-source@cloakapi.io

Back to /source/ · related: spec · conformance · implementations