Beta
Findings
Overview
A finding is one compliance result produced inside a workflow: a message for a person to read, an optional severity, and, depending on how the workflow owner configured it, a requirement that someone review and annotate it before the workflow can be considered complete.
You start from the workflow’s summary, whose score shows at a glance whether high-severity findings are still unreviewed. Then you read findings, decide what to do about the ones that need attention, and, where you hold permission, record that decision on the finding in one call: a note explaining why, a mark that it’s been reviewed and, if the check got it wrong, a corrected result. This guide covers that whole loop, plus attaching supporting documents to a finding.
You manage findings through the Findings API, under this base URL:
https://api.pointservices.com/riskinsight-services-ws/resources
How it fits together
Workflow — the compliance review this whole API is scoped to. It has an id, wfpop_0000000000002082611 in these docs, which every call here takes. It’s the same workflow the Sessions and Workflows guide and the Webhooks guide already work with. Findings are one more thing you can read and act on for a workflow you already have.
Summary and score — the workflow as a whole, read with one GET: a score, a tally of its findings by severity and review state (severityCounts), and its generated reports. score runs from 0 to 99, and higher is worse: 75 and above means there are unreviewed HIGH-severity findings. It can be missing when the workflow can’t be scored right now, which means “not known yet”, never zero. The summary carries no findings itself; see Get a Workflow’s Findings Summary.
Finding — one compliance result inside that workflow. It has an id, fndg_0000000000006051384 in these docs. Read the same finding from the flat list, the categorized view, or a direct GET, and you get the same JSON back: the three ways of fetching a finding are interchangeable.
Category — a workflow owner’s own grouping of findings, configured per workflow. A display label, not a stable key: see Reviewing a Finding for why you shouldn’t switch on it.
Review — whether a finding has been looked at (reviewed), alongside whether it needed to be (reviewRequired). You change reviewed, the review note and a corrected result with one edit call. Some findings require review; some don’t.
Attachment — a supporting document you or the system attached to a finding, such as a screenshot or a source PDF. Metadata and a download link live at their own address; the finding itself only signals whether any exist.
Getting started
New to this API? Start with Getting Started — it walks through reading a workflow’s summary and score, fetching its findings and reviewing the ones that need attention, start to finish.
Already reading findings and want the review lifecycle in depth, or need to attach documents? Jump to Reviewing a Finding or Attachments directly.