v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Matching

Get match run results

Use this endpoint to retrieve all match groups from a specific matching run. Each group contains matched transaction pairs and confidence scores. The response uses cursor-based pagination.

get/v1/matching/runs/{runId}/groups

Path parameters

runIdstring required

Run ID

Query parameters

contextIdstring required

Context ID

limitinteger

The maximum number of items to include in the response.

cursorstring

The cursor value for retrieving the next page of results.

sort_order'asc' | 'desc'

The order used to sort the results.

sort_by'id' | 'created_at' | 'status'

The field used to sort the results.

Headers

X-Request-Idstring

A unique identifier for tracing the request across services.

Response

Indicates that the request was successful and the response contains the expected data.

hasMoreboolean
limitinteger
nextCursorstring
prevCursorstring

Example response

{
  "hasMore": true,
  "limit": 20,
  "nextCursor": "eyJpZCI6IjEyMyJ9",
  "prevCursor": "eyJpZCI6IjEyMiJ9"
}