Get match run results

curl --request GET \
  --url https://matcher.sandbox.lerian.net/v1/matching/runs/{runId}/groups \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://matcher.sandbox.lerian.net/v1/matching/runs/{runId}/groups"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://matcher.sandbox.lerian.net/v1/matching/runs/{runId}/groups', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://matcher.sandbox.lerian.net/v1/matching/runs/{runId}/groups"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "hasMore": true,
  "items": [
    {
      "confidence": 85,
      "contextId": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": "2025-01-15T10:30:00Z",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "items": [
        {
          "allocatedAmount": "1000.00",
          "allocatedCurrency": "USD",
          "allowPartial": false,
          "createdAt": "2025-01-15T10:30:00Z",
          "expectedAmount": "1000.00",
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "matchGroupId": "550e8400-e29b-41d4-a716-446655440000",
          "transactionId": "550e8400-e29b-41d4-a716-446655440000",
          "updatedAt": "2025-01-15T10:30:00Z",
          "side": "LEFT",
          "sourceId": "550e8400-e29b-41d4-a716-446655440000",
          "sourceName": "Bank statement"
        }
      ],
      "runId": "550e8400-e29b-41d4-a716-446655440000",
      "status": "PROPOSED",
      "updatedAt": "2025-01-15T10:30:00Z",
      "confirmedAt": "2025-01-15T10:35:00Z",
      "reasonCodes": [
        "FX_RATE_VARIANCE"
      ],
      "rejectedReason": "amounts do not match within tolerance",
      "ruleId": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "limit": 20,
  "nextCursor": "eyJpZCI6IjEyMyJ9",
  "prevCursor": "eyJpZCI6IjEyMiJ9"
}

GET

matching

runs

{runId}

groups

Get match run results

curl --request GET \
  --url https://matcher.sandbox.lerian.net/v1/matching/runs/{runId}/groups \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://matcher.sandbox.lerian.net/v1/matching/runs/{runId}/groups"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://matcher.sandbox.lerian.net/v1/matching/runs/{runId}/groups', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://matcher.sandbox.lerian.net/v1/matching/runs/{runId}/groups"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "hasMore": true,
  "items": [
    {
      "confidence": 85,
      "contextId": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": "2025-01-15T10:30:00Z",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "items": [
        {
          "allocatedAmount": "1000.00",
          "allocatedCurrency": "USD",
          "allowPartial": false,
          "createdAt": "2025-01-15T10:30:00Z",
          "expectedAmount": "1000.00",
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "matchGroupId": "550e8400-e29b-41d4-a716-446655440000",
          "transactionId": "550e8400-e29b-41d4-a716-446655440000",
          "updatedAt": "2025-01-15T10:30:00Z",
          "side": "LEFT",
          "sourceId": "550e8400-e29b-41d4-a716-446655440000",
          "sourceName": "Bank statement"
        }
      ],
      "runId": "550e8400-e29b-41d4-a716-446655440000",
      "status": "PROPOSED",
      "updatedAt": "2025-01-15T10:30:00Z",
      "confirmedAt": "2025-01-15T10:35:00Z",
      "reasonCodes": [
        "FX_RATE_VARIANCE"
      ],
      "rejectedReason": "amounts do not match within tolerance",
      "ruleId": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "limit": 20,
  "nextCursor": "eyJpZCI6IjEyMyJ9",
  "prevCursor": "eyJpZCI6IjEyMiJ9"
}

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

runId

string<uuid>

required

Run ID

Query Parameters

contextId

string<uuid>

required

Context ID Context ID the run belongs to

limit

integer<int64>

default:20

The maximum number of items to include in the response. Maximum number of records to return

Required range: 1 <= x <= 200

cursor

string

The cursor value for retrieving the next page of results. Opaque pagination cursor

sort_order

enum<string>

The order used to sort the results. Sort order

Available options:

asc,

desc

sort_by

enum<string>

The field used to sort the results. Sort field

Available options:

id,

created_at,

status

status

enum<string>

Filter by match-group lifecycle status. Applied server-side so the filter is honest across all pages, not just the loaded one.

Available options:

PROPOSED,

CONFIRMED,

REJECTED,

REVOKED

Response

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

hasMore

boolean

required

Example:

true

items

object[] | null

required

Page of match groups

Maximum array length: 200

Show child attributes

limit

integer<int64>

required

Required range: 1 <= x <= 200

Example:

20

nextCursor

string

Example:

"eyJpZCI6IjEyMyJ9"

prevCursor

string

Example:

"eyJpZCI6IjEyMiJ9"

Getting started

Configuration Contexts API

Configuration Match Rules API

Configuration Sources API

Configuration Field Maps API

Configuration Fee Schedules API

Configuration Fee Rules API

Configuration Schedules API

Exception workflow

Bulk actions

Comments

Callback credentials

Disputes API

Export Jobs API

Governance API

Ingestion jobs

Layouts and formats

Extraction reviews

Document extraction

Match runs

Manual matching and adjustments

Candidates and open items

Rule suggestions

Dashboard and metrics

Reports

Exports

Discovery status

Discovery connections

Extractions

Aggregator connections

Aggregator webhooks

Error handling

Events

Get match run results

Authorizations

Headers

Path Parameters

Query Parameters

Response