Skip to content

Documentation

How to use Veridion, the concepts behind it, and the API that powers it.

Getting started

  1. Create a workspace. Sign up with your work email. You become the owner of a new organization.
  2. Add a company. Give its name and financial year end — the year end decides how periods such as FY2025 are dated.
  3. Upload documents. Start with the latest annual report and sustainability report. Set each document's type and reporting period.
  4. Run an assessment. On the Evidence tab, choose a requirement catalogue, the period, and rules-only or rules + model.
  5. Review the findings. Open each finding to follow its trail, open the source passage, and accept, override or comment.
  6. Act on the gaps. Assign owners and dates on the Actions tab, then export a report.

Concepts

Companies and peers

A company has documents, assessment runs and actions. Mark up to ten other companies as its peers to compare them.

Documents and versions

Each upload is an immutable version identified by its SHA-256 hash. Uploading a corrected file as a new version keeps the old one, so earlier findings still point to what they cited.

Passages and evidence identifiers

Documents are split into passages — paragraphs, headings, list items, tables and table rows — each with a page, a bounding box and a stable identifier such as ev_93a18ca53e4aace0f313. Values found in passages are stored with their unit, normalised unit and period.

Requirement catalogues

A catalogue is a versioned set of requirements, each made of weighted elements with defined evidence checks. Catalogues have effective dates and a review status; draft catalogues are labelled.

Runs, findings and statuses

An assessment run evaluates every applicable requirement in one catalogue against a company's current documents for one period, producing one finding per requirement with a status, a completeness score, a rationale, element results and linked evidence. See the methodology for the rules.

Actions

Gaps become actions ranked by importance × gap × urgency. Actions persist across runs and are closed by a person.

Running assessments

All documents must have finished processing before a run starts. Runs execute in the background; progress is shown on the Evidence tab. Set a reporting deadline to rank actions by urgency. To exclude a requirement that does not apply, record an applicability decision with a rationale before running.

Reviewing findings

Select a row in the Evidence Explorer, or use the arrow keys and Enter. The trail shows the requirement and its elements, the evidence on the page, the rationale with clickable citations, the gap and the linked action. An override needs a reason; comments never change the status.

Comparing peers

The Peers tab aligns units, shows each company's reporting period and consolidation approach, and lists comparability notes beside each value. Values not disclosed are shown as such.

Exports

  • Report — a printable page; use your browser's print dialog to save it as PDF.
  • CSV — one row per finding with status, review state, completeness, priority and primary source.
  • Markdown — the report as text.
  • Evidence package (JSON) — format veridion.evidence-package/1: the run manifest with document hashes and versions, every finding with its elements, evidence passages and reviews, the actions, and the limitations.

API

The REST API lives under /api/v1, and an interactive reference is served at /api/docs on every deployment. Browser sessions use an HttpOnly cookie; other clients send the session token as Authorization: Bearer …. Requests that change data from a browser must include the header X-Veridion-Client: web.

MethodPathPurpose
POST/api/v1/auth/loginSign in; returns your profile and sets the session
GET/api/v1/companiesList companies with document counts and the latest run
POST/api/v1/companies/{id}/documentsUpload a PDF (multipart); processing runs in the background
GET/api/v1/documents/{id}/passagesExtracted passages with page, position and values
GET/api/v1/requirement-setsAvailable requirement catalogues and their status
POST/api/v1/companies/{id}/runsStart an assessment run
GET/api/v1/runs/{id}/findingsFindings for a run, with review state
GET/api/v1/findings/{id}The full evidence trail for one finding
POST/api/v1/findings/{id}/reviewsAccept, override or comment on a finding
GET/api/v1/runs/{id}/diffWhat changed since another run, and why
GET/api/v1/companies/{id}/benchmarkPeer comparison with comparability notes
GET/api/v1/runs/{id}/export?format=jsonEvidence package (also csv, md)

Limits

Uploads are limited to PDF files of up to 50 MB. Plan limits on companies, documents, pages per document, runs and seats are listed on the pricing page and in your workspace settings. Exceeding a limit returns HTTP 402 with a message naming the limit.