Reconciliation

View reconciliation details

Read the status and match counts for one reconciliation run.

GET/reconciliation/{reconciliation_id}

Authorization

If set, the API uses an API key for authentication. Include the following header in your requests: X-blnk-key: <api-key>.

Replace <api-key> with your secret API key. Ensure the key is kept secure and not exposed in public repositories or client-side code.

Path

reconciliation_idstringrequiredpath

Id returned when you started the run. A missing id returns 400. An unknown id returns 404 with RECON_NOT_FOUND.

Response

reconciliation_idstringrequired

Id of the run.

upload_idstringrequired

Upload this run is matching. An instant run uses a generated id.

statusstringrequired

started, in_progress, completed, or failed.

matched_transactionsintegerrequired

For one_to_one, external records that matched. For one_to_many, ledger transactions inside matched groups. For many_to_one, external rows inside matched groups.

unmatched_transactionsintegerrequired

For one_to_one and one_to_many, external records that did not match. For many_to_one, ledger transactions that did not match.

is_dry_runbooleanrequired

Always false. Core does not store the dry-run flag.

started_atstringrequired

When the run was created.

completed_atstring

When the run finished. Null until the status is completed.

curl -X GET "http://localhost:5001/reconciliation/recon_6e6feddd-930b-4e3a-8ba1-a3eee659bb3c" \
  -H "X-blnk-key: <api-key>"

{
  "reconciliation_id": "recon_6e6feddd-930b-4e3a-8ba1-a3eee659bb3c",
  "upload_id": "upload_8c700d1b-09c0-4ef4-9ab1-a0decf3d0aa3",
  "status": "completed",
  "matched_transactions": 3,
  "unmatched_transactions": 0,
  "is_dry_run": false,
  "started_at": "2025-03-15T17:43:26.463849Z",
  "completed_at": "2025-03-15T17:43:26.508514Z"
}

{
  "error": "Reconciliation not found",
  "error_detail": {
    "code": "RECON_NOT_FOUND",
    "message": "Reconciliation not found"
  }
}