Skip to main content

Submission Inbox and Worklist

List reinsurance workbooks with capture, mapping and check status, list the target structures they map into, and read the worklist of what needs a person.

Three read routes give the overview of a workspace's submissions. GET /v1/submissions is the inbox: one row per top-level workbook with its capture, mapping and check status. GET /v1/submissions/specs lists the target structures workbooks are mapped into. GET /v1/submissions/issues is the worklist: everything across the submissions that needs a person, in one list. All three need the read scope.

An inbox row's status is not_captured (the workbook was never read), captured (read, but no facts mapped under the requested structure), mapped (facts exist under it) or failed (the capture failed). The counts facts, metrics, checks_failed and checks_warned refer to the structure named by spec_id. cedent is the first fact's Cedent field, else the value a person stated for the whole submission; stated values appear in the inbox before they reach the facts, because the facts follow by a background re-map.

GET/v1/submissions

Query parameters

spec_iduuidTarget structure the mapping status and counts refer to. Without it the counts are 0 and no submission is mapped.
qstringCase-insensitive substring over the file name.
limitintegerPage size, 1 to 500. Default: 100
offsetintegerRows to skip. Default: 0

Response fields (data)

totalintegerWorkbooks matching the filter, before paging.
submissions[].document_iduuidThe workbook document.
submissions[].statusstringnot_captured, captured, mapped or failed.
submissions[].facts / metricsintegerFacts mapped under the requested structure, and the distinct metrics among them.
submissions[].checks_failed / checks_warnedintegerFindings by severity.
submissions[].unmapped_labelsintegerLabels of the structure not yet approved (the same for every row).
submissions[].statedobjectField values a person stated for the whole submission.

cURL: List mapped workbooks of one structure

curl "https://api.talonic.com/v1/submissions?spec_id=5d1c0a52-0c1e-4b64-9d2e-7a3c4f1e9b10&q=utica&limit=20" \
  -H "Authorization: Bearer $TALONIC_API_KEY"

Response: Inbox page

{
  "data": {
    "total": 1,
    "submissions": [
      {
        "document_id": "0b9a41de-6a9e-4f6c-8f42-1d7f2a3c5e60",
        "filename": "utica-first-2024.xlsx",
        "cedent": "Utica First",
        "captured_at": "2026-10-02T09:14:31.000Z",
        "status": "mapped",
        "tables": 12,
        "values": 4180,
        "facts": 312,
        "metrics": 9,
        "checks_failed": 2,
        "checks_warned": 5,
        "unmapped_labels": 3,
        "embedded_files": 1,
        "stated": { "Cedent": "Utica First" }
      }
    ]
  }
}
GET/v1/submissions/specs

Response fields (data[])

iduuidThe structure id; pass it as spec_id.
namestringDisplay name of the structure.
updated_atdatetimeLast update.
field_countintegerFields of the structure.
labels_to_reviewintegerLabel mappings not yet approved.
GET/v1/submissions/issues

Query parameters

spec_iduuidInclude the issues that depend on a target structure.

Response fields (data[])

kindstringnot_captured, capture_failed, not_mapped, check_failed, labels_to_review or missing_metric.
document_iduuid | nullThe workbook; null for labels_to_review.
filenamestring | nullFile name of the workbook.
detailobjectDepends on kind: { spec_id } for not_mapped, { failed } for check_failed, { metrics } for missing_metric, { spec_id, count } for labels_to_review, empty otherwise.

Response: Worklist

{
  "data": [
    { "kind": "check_failed", "document_id": "0b9a41de-6a9e-4f6c-8f42-1d7f2a3c5e60", "filename": "utica-first-2024.xlsx", "detail": { "failed": 2 } },
    { "kind": "labels_to_review", "document_id": null, "filename": null, "detail": { "spec_id": "5d1c0a52-0c1e-4b64-9d2e-7a3c4f1e9b10", "count": 3 } }
  ]
}
The worklist is the quickest way to decide the next call. not_captured and not_mapped are cleared by POST /v1/submissions/process, labels_to_review by the label review, check_failed by reading the findings in GET /v1/submissions/:documentId/checks, and missing_metric by stating or correcting the source figures.

A labels_to_review item is global to the structure, not to a workbook, so its document_id is null. A missing_metric item names the metrics of the structure that a submission has no facts for, which makes it the first thing to check when a client format column stays empty in the export.

Frequently asked questions

Why are all counts 0 in the inbox?+
The counts of facts, metrics and checks refer to one target structure. Without spec_id they are 0 and no submission reports mapped. Pass the id of a structure from GET /v1/submissions/specs.
How many worklist items can be returned?+
At most 200. The list is meant to drive the next action, not to page through. Clear the items with the process and review routes, then read it again.
What does unmapped_labels count?+
The label mappings of the target structure that nobody has approved yet. It is the same number on every row of the inbox, because labels belong to the structure and not to a workbook.