Trigger a matching run

Use this endpoint to trigger a matching run for a reconciliation context. You can use DRY_RUN mode to test rules without committing results, or COMMIT mode to persist matches.

POST /v1/matching/contexts/{contextId}/run

Trigger a matching run

cURL

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",
  "async": false
}
'

202

Example

{
  "runId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "COMPLETED"
}

Autorizaciones

Authorization · string · header · requerido

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

Encabezados

X-Request-Id · string

A unique identifier for tracing the request across services.

X-Idempotency · string

Optional idempotency key for safe retries. Matcher reads the key only from this header, and only when you send one. A request that carries a key only in X-Idempotency-Key or Idempotency-Key is refused with 400 (MTCH-0015), and nothing is processed. If the same key is sent again and the original request was already processed, the stored response is returned with X-Idempotency-Replayed: true. A malformed key returns 400, a key whose first request is still in progress returns 409 (MTCH-0018), a key whose earlier attempt already ran but whose answer cannot be replayed returns 409 (MTCH-0022), and an idempotency storage failure returns 500. POST, PUT, PATCH and DELETE requests accept the header. These refusals are problem documents.

Parámetros de ruta

contextId · string<uuid> · requerido

The unique identifier of the reconciliation context. Reconciliation context ID

Cuerpo

application/json

Run match payload

mode · enum<string> · requerido

Execution mode

Opciones disponibles: DRY_RUN, COMMIT

Ejemplo:

"DRY_RUN"

async · boolean

Submit asynchronously: when true the run is queued (status QUEUED) and executed by the worker; when false/omitted the run executes in-request and the response carries the completed run (terminal status). Both paths return HTTP 202; distinguish by the response status. Poll GET /v1/matching/runs/{runId} for async progress.

Ejemplo:

false

Respuesta

202

application/json

Indicates that the request was accepted for processing.

runId · string<uuid> · requerido

Identifier of the match run that was triggered

Ejemplo:

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

status · enum<string> · requerido

Status of the run at acceptance: QUEUED (async submit, awaiting worker pickup), COMPLETED (finished synchronously), or FAILED (errored synchronously). A synchronous run is already terminal; an async run is QUEUED. Poll GET /v1/matching/runs/{runId} for async progress (PROCESSING/FINALIZING/COMPLETED)

Opciones disponibles: QUEUED, COMPLETED, FAILED

Ejemplo:

"COMPLETED"