v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Matching

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

Path parameters

contextIdstring required

The unique identifier of the reconciliation context.

Headers

X-Request-Idstring

A unique identifier for tracing the request across services.

X-Idempotency-Keystring

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.

Request body

mode'DRY_RUN' | 'COMMIT' required

Example request

{
  "mode": "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.

runIdstring uuid

status'PROCESSING' | 'COMPLETED' | 'FAILED'

Example response

{
  "runId": "019c96a0-0b88-7725-b825-efff420e20e0",
  "status": "PROCESSING"
}