# Match Result

Evaluates a ruleset against two records (e.g., “source” vs “target”) and returns a boolean match along with detailed rule outcomes.

Request
- Provide a JSON body with:
  - data: arbitrary objects such as sourceRecord and targetRecord holding fields to compare.
  - rule: a tree of evaluation rules (e.g., and, or, equal, lev-ratio) referencing fields via simple expressions.
- See the example for composing nested rules and thresholds (e.g., Levenshtein ratio with threshold).

Successful response (200)
- Returns EvaluateResultModel:
  - isMatch: overall boolean result of the ruleset.
  - fullResult: hierarchical RuleResult tree with match outcomes and causes.
  - namedResults: flattened list of RuleResult items for named rules.

Use cases
- Name normalization and fuzzy matching (e.g., lev-ratio across concatenated name parts).
- Combining exact comparisons (equal) with fallback logic (or) inside higher-level and conditions.

Errors
- 401/403: authentication/authorization failure.
- 422: invalid body or rule specification (see ErrorResponse).

Auth
- Requires x-api-key with the ApiKeyPolicy.

Endpoint: POST /api/v1/verification/match
Version: 1.0
Security: ApiKey

## Response 200 fields (application/json):

  - `isMatch` (boolean)
    Overall result of the Rule evaluation.

  - `fullResult` (object)

  - `fullResult.name` (string,null)
    Name identifier of the evaluated rule

  - `fullResult.rule` (string,null)
    The type of rule evaluated. e.g. equal, contain, etc.

  - `fullResult.isMatch` (boolean)
    Status of the rule evaluation - true or false

  - `fullResult.results` (array,null)
    Details of rule evaluation.

  - `fullResult.cause` (string,null)
    Failure cause, if status is false.

  - `namedResults` (array,null)
    Result of individual rule evaluation - flattened.

## Response 422 fields (application/json):

  - `status` (integer)

  - `message` (string,null)

  - `errorCode` (string,null)

  - `details` (string,null)

  - `timestamp` (string)

  - `diagnosticsId` (string,null)


## Response 401 fields

## Response 403 fields