Skip to main content
GET
Get match

Authorizations

Authorization
string
header
required

API key, not necessarily a JWT. Server derives Organization, permitted actions and Corpus scope; every resource access is authorized.

Path Parameters

match_id
string
required
Minimum string length: 1

Response

Successful response

Immutable positive historical determination, not a claim of current eligibility. Unique subscription-version/record-version. Correction/withdrawal notifications reference history; no Match is fabricated for negative decisions. owner is the Subscription's owner, absent when global.

match_id
string
required
Minimum string length: 1
subscription_id
string
required
Minimum string length: 1
subscription_version_id
string
required
Minimum string length: 1
saved_query_id
string
required
Minimum string length: 1
saved_query_version_id
string
required
Minimum string length: 1
record_id
string
required
Minimum string length: 1
record_version_id
string
required
Minimum string length: 1
evidence
object
required

Immutable evidence for a positive result, including evaluator version/configuration. Details are plugin-defined, bounded to 16 KiB and schema-validated by its adapter; core checks referenced Parts. Access is rechecked on reads.

previous_match_id
string
Minimum string length: 1
owner
string

Subscription Owner, an opaque end-user reference defined by the client application (for example user-123). Quivr stores, filters and echoes it without interpreting it. At most 128 characters without control characters; none is reserved for the listing filter (422 invalid_owner).

Required string length: 1 - 128