Skip to main content

Document-Case Map

Get the mapping of documents to their resolved cases. Returns a mapping of document IDs to assigned case keys.

GET/v1/linking/document-case-map

Response

Response fields

dataobjectMap of document UUID to case assignment object.
data.{document_id}.case_keystringThe case key this document belongs to. Empty string for entity-group-only documents.
data.{document_id}.document_countintegerNumber of documents in the case or entity group.
data.{document_id}.is_casebooleanTrue if this document belongs to a case (linked via transaction/reference entities). False if linked only via identity entities.

Response

{
  "data": {
    "doc_uuid_1": {
      "case_key": "a1b2c3d4e5f6a7b8",
      "document_count": 4,
      "is_case": true
    },
    "doc_uuid_2": {
      "case_key": "a1b2c3d4e5f6a7b8",
      "document_count": 4,
      "is_case": true
    },
    "doc_uuid_3": {
      "case_key": "",
      "document_count": 2,
      "is_case": false
    }
  }
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Related

Full Graph