Skip to main content
POST
/
reconciliation
/
start
Start reconciliation
curl --request POST \
  --url http://localhost:5001/reconciliation/start \
  --header 'X-blnk-key: <api-key>'
import requests

url = "http://localhost:5001/reconciliation/start"

headers = {"X-blnk-key": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)
const options = {method: 'POST', headers: {'X-blnk-key': '<api-key>'}};

fetch('http://localhost:5001/reconciliation/start', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "5001",
  CURLOPT_URL => "http://localhost:5001/reconciliation/start",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "X-blnk-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:5001/reconciliation/start"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("X-blnk-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("http://localhost:5001/reconciliation/start")
  .header("X-blnk-key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:5001/reconciliation/start")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["X-blnk-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
Use blnk.reconciliation.run to start batch reconciliation.
1

Call the method

blnk.reconciliation.run
response = blnk.reconciliation.run({
  "upload_id": "upload_8c700d1b-09c0-4ef4-9ab1-a0decf3d0aa3",
  "strategy": "one_to_one",
  "dry_run": True,
  "grouping_criteria": "reference",
  "matching_rule_ids": ["rule_abc123"],
})
FieldTypeDescription
upload_idstrUpload ID returned by blnk.reconciliation.upload.
strategystrMatch strategy: one_to_one, one_to_many, or many_to_one.
dry_runboolSet True to test without writing results to the ledger.
grouping_criteriastrField used to group records, for example reference.
matching_rule_idsstring[]IDs of the matching rules to apply.
2

Save the reconciliation ID

Use response.data["reconciliation_id"] with blnk.reconciliation.get to poll status and match counts.
3

Response

200 OK
{
  "reconciliation_id": "rec_a8f2c91d-1234-4abc-9def-0123456789ab"
}
FieldTypeDescription
reconciliation_idstrID of the reconciliation run. Use it with blnk.reconciliation.get to check status.

How reconciliation works

Batch and instant reconciliation workflows.

Start reconciliation

HTTP request and response schema.

​
Need help?

We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool. To ask questions or discuss issues, please contact us or join our Discord community.