Skip to main content
POST
/
v1
/
matching
/
contexts
/
{contextId}
/
run
Trigger a matching run
curl --request POST \
  --url https://matcher.sandbox.lerian.net/v1/matching/contexts/{contextId}/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mode": "DRY_RUN"
}
'
{
  "runId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "PROCESSING"
}

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
required

The unique identifier of the reconciliation context.

Body

application/json

Run match payload

​
mode
enum<string>
required
Available options:
DRY_RUN,
COMMIT
Example:

"DRY_RUN"

Response

Indicates that the request was accepted for processing.

​
runId
string<uuid>
Example:

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

​
status
enum<string>
Available options:
PROCESSING,
COMPLETED,
FAILED
Example:

"PROCESSING"