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.

The document-case map provides a flat lookup from document ID to case assignment. Use it to quickly determine which case a document belongs to, or to identify documents that are not part of any case. Documents in entity groups (linked only through identity entities) are included with is_case: false.

Call this endpoint when you need to enrich a document list with case membership — for example, to display a case badge next to each document in a table view. The response is a flat object keyed by document UUID, so lookups are O(1) without client-side joins.

Each entry includes a case_key (the deterministic hex hash identifying the case), a document_count (total documents in that case or entity group), and an is_case boolean. When is_case is false, the case_key is an empty string — the document is linked via identity entities only.

This endpoint pairs well with the Cases list endpoint. Use the map for bulk lookups across your document set, and the Cases endpoint when you need case-level metadata like labels or timestamps. Documents with no entity links at all are omitted from the map entirely.

Documents with is_case: false are linked to other documents only through identity entities (e.g. same vendor). They appear in the map but do not form a case. Documents with no links at all are not included in the map.
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
Cases