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": "019c96a0-0b88-7725-b825-efff420e20e0",
  "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.

​
X-Idempotency-Key
string

Optional idempotency key for safe retries. Also accepts Idempotency-Key as an alternative header name. If the same key is sent again and the original request was already processed, the cached response is returned with X-Idempotency-Replayed: true.

See Retries and idempotency for details.

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.

The response includes the X-Idempotency-Replayed header.

If the value is false, the request was just processed. If the value is true, the response is a replay of a previously processed request.

See Retries and idempotency for more details.

​
runId
string<uuid>
Example:

"019c96a0-0b88-7725-b825-efff420e20e0"

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

"PROCESSING"