Matching

Get a matching run

Returns the run summary together with up to the 50 top-confidence match results.

get/v1/matching/runs/{id}

Request

Base URL: https://api.talonic.com
URL: https://api.talonic.com/v1/matching/runs/{id}
Auth: HTTP bearer

Path parameters

idstring uuid required

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Resource UUID.

Response

Matching run with result summary.

idstring uuid required

matching_config_idstring uuid required

status'queued' | 'running' | 'completed' | 'failed' | 'cancelled' required

triggered_bystring

rows_processedinteger nullable

rows_matchedinteger nullable

avg_confidencenumber float nullable

started_atstring date-time nullable

completed_atstring date-time nullable

errorstring nullable

created_atstring date-time

Example response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "matching_config_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "completed",
  "triggered_by": "manual",
  "started_at": "2026-04-25T14:30:00.000Z",
  "completed_at": "2026-04-25T14:30:00.000Z",
  "created_at": "2026-04-25T14:30:00.000Z",
  "results": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "document_id": "f0e1d2c3-b4a5-9687-8765-432109876543",
      "matched_reference_row_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "status": "matched"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.