Skip to main content

Case Edges

List, confirm, or reject linking edges within a case. Edges represent shared-value connections between documents in the linking graph.

Edges are the connections between documents in a case, created by the linking engine when documents share field values. Confirm or reject edges to refine case membership.

GET/v1/cases/:key/edges

Response

Response fields

dataarrayArray of edge objects.
data[].idstringEdge UUID.
data[].document_a_idstringFirst document UUID.
data[].document_b_idstringSecond document UUID.
data[].field_astringField name on document A that produced the shared value.
data[].field_bstringField name on document B that produced the shared value.
data[].final_scorenumberEdge confidence score (0–1).
data[].rejectedbooleanWhether this edge has been rejected.

Response

{
  "data": [
    {
      "id": "edge_uuid_1",
      "document_a_id": "doc_uuid_1",
      "document_b_id": "doc_uuid_2",
      "field_a": "vendor_id",
      "field_b": "vendor_id",
      "final_score": 0.92,
      "rejected": false
    }
  ]
}
POST/v1/cases/:key/edges/:edgeId/confirm

Response

Response fields

successbooleanAlways true on success.
edge_idstringUUID of the confirmed edge.

Response

{ "success": true, "edge_id": "edge_uuid_1" }
POST/v1/cases/:key/edges/:edgeId/reject

Response

Response fields

successbooleanAlways true on success.
edge_idstringUUID of the rejected edge.

Response

{ "success": true, "edge_id": "edge_uuid_1" }

Errors

Error responses

400bad_requestInvalid case key or edge ID format.
401unauthorizedMissing or invalid API key.
404not_foundCase or edge not found.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Related

Get Case
Linking