Start Full Reconciliation

curl --request POST \
  --url https://plugin-pix-indirect.api.lerian.net/v1/dict/reconciliation/full \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://plugin-pix-indirect.api.lerian.net/v1/dict/reconciliation/full"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://plugin-pix-indirect.api.lerian.net/v1/dict/reconciliation/full', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://plugin-pix-indirect.api.lerian.net/v1/dict/reconciliation/full",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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 := "https://plugin-pix-indirect.api.lerian.net/v1/dict/reconciliation/full"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://plugin-pix-indirect.api.lerian.net/v1/dict/reconciliation/full")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "jobs": [
    {
      "createdAt": "2024-01-15T10:30:00Z",
      "expiresAt": "2024-01-15T12:30:00Z",
      "fileRequestId": "770e8400-e29b-41d4-a716-446655440002",
      "jobId": "550e8400-e29b-41d4-a716-446655440000",
      "keyType": "CPF",
      "status": "WAITING_FILE"
    }
  ],
  "message": "Created 2 full reconciliation jobs",
  "skippedKeyTypes": [
    {
      "keyType": "CNPJ",
      "reason": "Already synchronized (SYNCED)",
      "syncStatus": "SYNCED"
    }
  ]
}

{
  "jobs": [
    {
      "createdAt": "2024-01-15T10:30:00Z",
      "expiresAt": "2024-01-15T12:30:00Z",
      "fileRequestId": "770e8400-e29b-41d4-a716-446655440002",
      "jobId": "550e8400-e29b-41d4-a716-446655440000",
      "keyType": "CPF",
      "status": "WAITING_FILE"
    }
  ],
  "message": "Created 2 full reconciliation jobs",
  "skippedKeyTypes": [
    {
      "keyType": "CNPJ",
      "reason": "Already synchronized (SYNCED)",
      "syncStatus": "SYNCED"
    }
  ]
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

Start Full Reconciliation

Triggers full reconciliation for all key types that are currently out of sync.

This endpoint detects which key types have OUT_OF_SYNC status and requests CID files from BTG for each of them. The actual reconciliation processing happens asynchronously via webhooks when the files become available.

Response codes:

202 Accepted: One or more reconciliation jobs were created
200 OK: All key types are already synchronized (no jobs created)

POST

dict

reconciliation

full

Start Full Reconciliation

curl --request POST \
  --url https://plugin-pix-indirect.api.lerian.net/v1/dict/reconciliation/full \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://plugin-pix-indirect.api.lerian.net/v1/dict/reconciliation/full"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://plugin-pix-indirect.api.lerian.net/v1/dict/reconciliation/full', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://plugin-pix-indirect.api.lerian.net/v1/dict/reconciliation/full",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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 := "https://plugin-pix-indirect.api.lerian.net/v1/dict/reconciliation/full"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://plugin-pix-indirect.api.lerian.net/v1/dict/reconciliation/full")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "jobs": [
    {
      "createdAt": "2024-01-15T10:30:00Z",
      "expiresAt": "2024-01-15T12:30:00Z",
      "fileRequestId": "770e8400-e29b-41d4-a716-446655440002",
      "jobId": "550e8400-e29b-41d4-a716-446655440000",
      "keyType": "CPF",
      "status": "WAITING_FILE"
    }
  ],
  "message": "Created 2 full reconciliation jobs",
  "skippedKeyTypes": [
    {
      "keyType": "CNPJ",
      "reason": "Already synchronized (SYNCED)",
      "syncStatus": "SYNCED"
    }
  ]
}

{
  "jobs": [
    {
      "createdAt": "2024-01-15T10:30:00Z",
      "expiresAt": "2024-01-15T12:30:00Z",
      "fileRequestId": "770e8400-e29b-41d4-a716-446655440002",
      "jobId": "550e8400-e29b-41d4-a716-446655440000",
      "keyType": "CPF",
      "status": "WAITING_FILE"
    }
  ],
  "message": "Created 2 full reconciliation jobs",
  "skippedKeyTypes": [
    {
      "keyType": "CNPJ",
      "reason": "Already synchronized (SYNCED)",
      "syncStatus": "SYNCED"
    }
  ]
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

All key types synchronized

Response from full reconciliation start operation.

jobs

object[]

Jobs contains information about the created jobs.

Show child attributes

message

string

Message provides details about the operation. @Example Created 2 full reconciliation jobs

Example:

"Created 2 full reconciliation jobs"

skippedKeyTypes

object[]

SkippedKeyTypes lists key types that were skipped.

Show child attributes

⌘I

Pix — Lerian SPI (native messaging)

Pix — JD (interface, direct)

Pix — BTG (interface, indirect)

TED — Lerian SPB (native messaging)

TED — JD (interface)

Boletos — BTG (interface)

Lerian SILOC (native messaging)

Lerian SLC (native messaging)

Lerian STA (native messaging)

Lerian SISBAJUD (native messaging)

Lerian Consignado (native messaging)

Start Full Reconciliation

Authorizations

Response