Skip to main content
GET
Get a match rule

Authorizations

Authorization
string
header
required

Bearer token authentication (format: "Bearer {token}")

Headers

X-Request-Id
string

A unique identifier for tracing the request across services.

Path Parameters

contextId
string<uuid>
required

The unique identifier of the reconciliation context. Context ID

ruleId
string<uuid>
required

The unique identifier of the match rule. Rule ID

Response

Successfully retrieved match rule

config
object
required

Rule-specific configuration object (matched fields and tolerance/lag parameters).

contextId
string
required

Identifier of the context this rule belongs to.

Example:

"550e8400-e29b-41d4-a716-446655440000"

createdAt
string
required

Creation timestamp in RFC 3339 format.

Example:

"2025-01-15T10:30:00Z"

id
string
required

Unique identifier of the rule.

Example:

"550e8400-e29b-41d4-a716-446655440000"

priority
integer<int64>
required

Execution priority; lower numbers run first.

Required range: 1 <= x <= 1000
Example:

1

type
enum<string>
required

Matching strategy. EXACT requires identical field values; TOLERANCE allows configured numeric slack; DATE_LAG allows a configured date offset between sides; FUZZY matches on normalized/similarity-scored references and always proposes for review.

Available options:
EXACT,
TOLERANCE,
DATE_LAG,
FUZZY
Example:

"EXACT"

updatedAt
string
required

Last update timestamp in RFC 3339 format.

Example:

"2025-01-15T10:30:00Z"