Assign an exception

curl --request POST \
  --url https://matcher.sandbox.lerian.net/v1/exceptions/{exceptionId}/assign \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assignee": "user@example.com"
}
'

package main

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

func main() {

	url := "https://matcher.sandbox.lerian.net/v1/exceptions/{exceptionId}/assign"

	payload := strings.NewReader("{\n  \"assignee\": \"user@example.com\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({assignee: 'user@example.com'})
};

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

import requests

url = "https://matcher.sandbox.lerian.net/v1/exceptions/{exceptionId}/assign"

payload = { "assignee": "user@example.com" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "createdAt": "2025-01-15T10:30:00Z",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "severity": "HIGH",
  "status": "OPEN",
  "transactionId": "550e8400-e29b-41d4-a716-446655440001",
  "updatedAt": "2025-01-15T10:30:00Z",
  "amount": "1250.50",
  "assignedTo": "user@example.com",
  "contextId": "550e8400-e29b-41d4-a716-446655440004",
  "currency": "USD",
  "dueAt": "2025-01-20T10:30:00Z",
  "externalIssueId": "RECON-1234",
  "externalSystem": "JIRA",
  "reason": "Amount mismatch detected",
  "resolutionNotes": "Resolved via force match",
  "resolutionReason": "BUSINESS_DECISION",
  "resolutionType": "FORCE_MATCH",
  "resolvedAt": "2025-01-15T12:00:00Z",
  "resolvedBy": "user@example.com",
  "runId": "550e8400-e29b-41d4-a716-446655440002",
  "settlement": {
    "credited": "95.00",
    "currency": "BRL",
    "difference": "-2.00",
    "expected": "97.00"
  },
  "sourceId": "550e8400-e29b-41d4-a716-446655440003",
  "sourceName": "Bank feed",
  "transactionDate": "2025-01-14T00:00:00Z"
}

POST

exceptions

{exceptionId}

assign

Assign an exception

curl --request POST \
  --url https://matcher.sandbox.lerian.net/v1/exceptions/{exceptionId}/assign \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assignee": "user@example.com"
}
'

package main

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

func main() {

	url := "https://matcher.sandbox.lerian.net/v1/exceptions/{exceptionId}/assign"

	payload := strings.NewReader("{\n  \"assignee\": \"user@example.com\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({assignee: 'user@example.com'})
};

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

import requests

url = "https://matcher.sandbox.lerian.net/v1/exceptions/{exceptionId}/assign"

payload = { "assignee": "user@example.com" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "createdAt": "2025-01-15T10:30:00Z",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "severity": "HIGH",
  "status": "OPEN",
  "transactionId": "550e8400-e29b-41d4-a716-446655440001",
  "updatedAt": "2025-01-15T10:30:00Z",
  "amount": "1250.50",
  "assignedTo": "user@example.com",
  "contextId": "550e8400-e29b-41d4-a716-446655440004",
  "currency": "USD",
  "dueAt": "2025-01-20T10:30:00Z",
  "externalIssueId": "RECON-1234",
  "externalSystem": "JIRA",
  "reason": "Amount mismatch detected",
  "resolutionNotes": "Resolved via force match",
  "resolutionReason": "BUSINESS_DECISION",
  "resolutionType": "FORCE_MATCH",
  "resolvedAt": "2025-01-15T12:00:00Z",
  "resolvedBy": "user@example.com",
  "runId": "550e8400-e29b-41d4-a716-446655440002",
  "settlement": {
    "credited": "95.00",
    "currency": "BRL",
    "difference": "-2.00",
    "expected": "97.00"
  },
  "sourceId": "550e8400-e29b-41d4-a716-446655440003",
  "sourceName": "Bank feed",
  "transactionDate": "2025-01-14T00:00:00Z"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

exceptionId

string<uuid>

required

Exception ID (UUID)

Example:

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

Body

application/json

assignee

string

required

User to assign the exception to

Required string length: 1 - 255

Example:

"user@example.com"

Response

createdAt

string

required

Creation timestamp as an RFC 3339 timestamp

Example:

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

string

required

Unique identifier for the exception (UUID)

Example:

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

severity

enum<string>

required

Severity level: LOW and MEDIUM are informational, HIGH needs prompt review, CRITICAL requires immediate action

Available options:

LOW,

MEDIUM,

HIGH,

CRITICAL

Example:

"HIGH"

status

enum<string>

required

Lifecycle status: OPEN (unhandled), ASSIGNED (owned by a user), PENDING_RESOLUTION (a resolution is in flight), RESOLVED (closed out)

Available options:

OPEN,

ASSIGNED,

PENDING_RESOLUTION,

RESOLVED

Example:

"OPEN"

transactionId

string

required

Identifier of the transaction this exception was raised for (UUID)

Example:

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

updatedAt

string

required

Last update timestamp as an RFC 3339 timestamp

Example:

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

amount

string

Enrichment: the exception transaction's amount as a decimal string in the transaction's currency. Present on list rows and get-by-id when the transaction still exists.

Example:

"1250.50"

assignedTo

string

User the exception is currently assigned to

Example:

"user@example.com"

contextId

string

Enrichment: id of the reconciliation context the exception's source belongs to (UUID). Present on list rows and get-by-id when the transaction and source still exist; powers the global triage queue's context attribution.

Example:

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

currency

string

Enrichment: ISO 4217 currency code of the exception transaction's amount. Present on list rows and get-by-id when the transaction still exists.

Example:

"USD"

dueAt

string

Resolution due date as an RFC 3339 timestamp

Example:

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

externalIssueId

string

Issue identifier in the external system, when dispatched

Example:

"RECON-1234"

externalSystem

string

External system the exception was dispatched to, when applicable

Example:

"JIRA"

reason

string

Reason the exception was originally raised

Example:

"Amount mismatch detected"

resolutionNotes

string

Free-text notes captured when the exception was resolved

Example:

"Resolved via force match"

resolutionReason

string

Reason code recorded for the resolution

Example:

"BUSINESS_DECISION"

resolutionType

string

How the exception was resolved.

Example:

"FORCE_MATCH"

resolvedAt

string

When the exception was resolved, as an RFC 3339 timestamp. Present only for RESOLVED exceptions.

Example:

"2025-01-15T12:00:00Z"

resolvedBy

string

Principal that resolved the exception (JWT sub, or 'system' for automated callback resolutions). Empty until resolved or when the resolving path is un-attributed.

Example:

"user@example.com"

runId

string

Identifier of the match run that LATEST surfaced this exception (UUID). Refreshed on every re-run that re-surfaces the break, so it names the most recent run that touched it; powers the run-precise jump from a run to its exceptions. Absent for legacy rows written before run linkage and for ingestion-minted duplicate-transaction breaks (not produced by a match run).

Example:

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

settlement

object

Settlement figures for a fee break (expected vs credited and the signed difference), derived from the live fee-variance snapshot recorded for the exception's transaction. Present on get-by-id only, and only when the snapshot and the transaction amount are both available in the same currency.

Show child attributes

sourceId

string

Enrichment: id of the reconciliation source the exception transaction belongs to (UUID). Present on list rows and get-by-id when the transaction still exists.

Example:

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

sourceName

string

Enrichment: display name of the reconciliation source. Present on get-by-id when the transaction and its source still exist.

Example:

"Bank feed"

transactionDate

string

Enrichment: the exception transaction's value date as an RFC 3339 timestamp. Present on list rows and get-by-id when the transaction still exists.

Example:

"2025-01-14T00:00:00Z"

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

Assign an exception

Authorizations

Path Parameters

Body

Response