Issues and Export

Read the worklist of failed and unclear compliance checks, or download every verdict as CSV or XLSX, for documents and document sets, via /v1/compliance.

Two read routes collect the outcome of evaluations across the workspace. GET /v1/compliance/issues returns the worklist: the failing rules of the latest finished evaluation of each document set, then of each listed document, each with its reason and quote. GET /v1/compliance/export returns a file with one row per rule verdict. Both read finished evaluations only, so a document whose evaluation is still running appears once it completes.

A set's entry in the worklist has set_id filled and document_id null, and each of its checks names the member its quote comes from in document_id and document_name. A document's entry has document_id and a null set_id. Only evaluations with at least one failing check are listed, or at least one failing or unclear check with unclear=true. Sets come first, then documents.

GET/v1/compliance/issues

Query parameters

unclearstringtrue or 1 also lists unclear checks.

Group fields

document_id / set_idstring | nullExactly one is set: the document, or the document set.

filename / display_namestringThe document's file name, or the set's name.

document_countintegerMembers of the set; 1 for a document.

evaluation_idstring (uuid)The evaluation the checks come from.

outdatedbooleanWhether the evaluation is outdated.

finished_atstring (date-time) | nullWhen the evaluation finished.

results[]arrayThe checks: framework_document_id, framework_name, rule_code, rule_text, verdict (fail or unclear), reason, quote, document_id, document_name and needs_check.

cURL: Failed checks only

curl "https://api.talonic.com/v1/compliance/issues" \
  -H "Authorization: Bearer $TALONIC_API_KEY"

Response: 200 Set entry (excerpt)

{
  "data": [
    {
      "document_id": null,
      "set_id": "b6d02f4a-1e87-4c39-a5f0-83c9e7d142b8",
      "filename": "ACME delivery 2026-10",
      "display_name": null,
      "document_count": 2,
      "evaluation_id": "f1a8c350-6b24-4d9e-87c3-2e5d0b9a7f64",
      "outdated": false,
      "finished_at": "2026-10-20T10:41:09.000Z",
      "results": [
        {
          "framework_document_id": "9d0c4f6e-3b1a-4c53-8f0e-2a7b6c1d5e40",
          "framework_name": "Supplier Code of Conduct",
          "rule_code": "R-12",
          "rule_text": "The declaration must name the same supplier as the order.",
          "verdict": "fail",
          "reason": "[D2] names ACME Ltd; [D1] names ACME GmbH.",
          "quote": "Supplier: ACME Ltd",
          "document_id": "a83c06d2-9e1f-4b57-8c20-4d7f1e95a6b3",
          "needs_check": true,
          "document_name": "declaration.pdf"
        }
      ]
    }
  ]
}

GET/v1/compliance/export

Query parameters

formatstringcsv or xlsx, case-insensitive. Any other value returns 400. Default: csv

issuesstringtrue or 1 limits the file to the failed and unclear verdicts of the sets.

The columns, in order, are Type, Name, Document of the group, Framework, Rule, Rule text, Obligation, Verdict, Please check, Reason, Quote, Evaluated at and Outdated. The file is named compliance-evaluations-<date>, or compliance-discrepancies-<date> with issues=true. The content type is text/csv for CSV and application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for XLSX.

cURL: Download an XLSX of failed set checks

curl "https://api.talonic.com/v1/compliance/export?format=xlsx&issues=true" \
  -H "Authorization: Bearer $TALONIC_API_KEY" \
  -o compliance-discrepancies.xlsx

With issues=true the export covers the document sets only, while GET /v1/compliance/issues lists sets first and then single documents. For the failed checks of a single document, read GET /v1/compliance/evaluations/documents/{documentId} or the worklist.

Frequently asked questions

Why is a document missing from the worklist?+

The worklist lists the latest finished evaluation of each document or set, and only when it has a failing check (or an unclear one with unclear=true). A document that is still being evaluated, or whose checks all passed, does not appear.

What does the Please check column mean?+

It mirrors needs_check: the platform's readings disagreed on that rule and a third reading decided, so a person should look at the result first.

How do I get a spreadsheet instead of JSON?+

Call GET /v1/compliance/export with format=xlsx (or csv, the default). The response is an attachment; save it with -o in cURL or read the body as a binary stream.

Does the export include outdated evaluations?+

Yes. Each row carries an Outdated column, so an evaluation that predates a rule or framework change is visible as such rather than silently dropped.

Issues and Export

Frequently asked questions

Related