Preflight the tenant's ledger routing configuration (admin)

curl --request GET \
  --url https://api.example.com/v1/admin/ledger-routing/preflight \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

	url := "https://api.example.com/v1/admin/ledger-routing/preflight"

	req, _ := http.NewRequest("GET", 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))

}

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

fetch('https://api.example.com/v1/admin/ledger-routing/preflight', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "documentState": "bindings",
  "judicialAccountsDocumentState": "entries",
  "lines": [
    {
      "covered": true,
      "flowType": "BLOCK",
      "ledgerId": "0196a1b2-0000-7000-8000-0000000000b1",
      "membership": "verified",
      "organizationId": "0196a1b2-0000-7000-8000-0000000000a1",
      "reasons": [
        "transaction_route_not_found"
      ],
      "routesEnabled": true,
      "verdict": "ok",
      "ledgerValidateRoutes": true,
      "mode": "routes"
    }
  ],
  "organizationsDocumentState": "entries",
  "ready": false
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Preflight the tenant's ledger routing configuration (admin)

Checks the caller tenant’s ledger routing documents against the institution’s ledger. For every organization with accounting routes enabled (routing.organizations): transaction and operation routes exist, the legs are members of the transaction route, their operation types, direct entries and account rules match, a ledger that validates account types has the block account type registered, and each flow of every configured ledger has a binding. An organization without routes is checked the same way, so it can be fixed before routes are turned on, but its lines are not_applicable unless its writes are refused without routes too (organization_routes_disabled). Every TRANSFER, with or without routes, needs a judicial deposit account: transfer.judicial_accounts for the legacy executor; in executor mode (the plugin) the institution’s connector_metadata.executorLedger.judicialDepositAccountAlias, whose account must exist, unblocked, in the executor ledger. The executor-mode report reflects the STORED executorLedger; the running plugin keeps the one it loaded at boot until it restarts. The report never carries an account alias. The route is read-only: it never writes a document nor the ledger. Single-tenant (MULTI_TENANT_ENABLED=false) the institution is the required institutionId query parameter, with auth on or off, and the documents are the instance’s single-tenant ones. Multi-tenant the tenant and institution are the validated token’s tenantId, never the request; an institutionId that differs from it is refused with 403. Requires tenant_policy:read.

GET

admin

ledger-routing

preflight

Preflight the tenant's ledger routing configuration (admin)

curl --request GET \
  --url https://api.example.com/v1/admin/ledger-routing/preflight \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

	url := "https://api.example.com/v1/admin/ledger-routing/preflight"

	req, _ := http.NewRequest("GET", 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))

}

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

fetch('https://api.example.com/v1/admin/ledger-routing/preflight', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "documentState": "bindings",
  "judicialAccountsDocumentState": "entries",
  "lines": [
    {
      "covered": true,
      "flowType": "BLOCK",
      "ledgerId": "0196a1b2-0000-7000-8000-0000000000b1",
      "membership": "verified",
      "organizationId": "0196a1b2-0000-7000-8000-0000000000a1",
      "reasons": [
        "transaction_route_not_found"
      ],
      "routesEnabled": true,
      "verdict": "ok",
      "ledgerValidateRoutes": true,
      "mode": "routes"
    }
  ],
  "organizationsDocumentState": "entries",
  "ready": false
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Query Parameters

institutionId

string

Institution to preflight (UUID). Required single-tenant (MULTI_TENANT_ENABLED=false), where one instance hosts many institutions. Multi-tenant the institution is the validated token's tenantId; when sent it must equal that tenant, otherwise the request is refused with 403.

Example:

"0196a1b2-0000-7000-8000-000000000001"

Response

documentState

enum<string>

required

Shape of the tenant's ledger bindings document (tenant_policy/routing.ledger_bindings): sentinel is the unconfigured {} default, empty has no binding, bindings has at least one, invalid is a stored document that does not parse.

Available options:

sentinel,

empty,

bindings,

invalid

Example:

"bindings"

judicialAccountsDocumentState

enum<string>

required

Shape of the tenant's transfer.judicial_accounts document, which holds the judicial deposit account of each organization and ledger for the legacy executor: sentinel is the {} default (no account), empty has no entry, entries has at least one, invalid does not parse. In executor mode the plugin does not use it, and invalid does not block the report.

Available options:

sentinel,

empty,

entries,

invalid

Example:

"entries"

lines

object[] | null

required

One line per binding, plus one per flow or organization the connector writes to that has no binding or judicial account (covered=false). No line carries an account alias.

Show child attributes

organizationsDocumentState

enum<string>

required

Shape of the tenant's routing.organizations document, which enables accounting routes per organization: sentinel is the {} default (no organization uses routes), empty has no entry, entries has at least one, invalid does not parse.

Available options:

sentinel,

empty,

entries,

invalid

Example:

"entries"

ready

boolean

required

True only when the documents the run uses parse (in executor mode transfer.judicial_accounts is not used), every line is ok or not_applicable and, when some organization has routes enabled, the bindings document carries bindings.

Example:

false

SISBAJUD Mensageria · Institutions

SISBAJUD Mensageria · Orders and files

SISBAJUD Mensageria · Monitoring

SISBAJUD Mensageria · Return files

SISBAJUD Mensageria · LGPD requests

SISBAJUD Mensageria · Security

SISBAJUD Mensageria · Compliance

SISBAJUD Mensageria · Lerian STA dead-letter

SISBAJUD executor · Institutions and Midaz connector

SISBAJUD executor · Orders that need attention

SISBAJUD executor · Ledger routing

SISBAJUD executor · Security

SISBAJUD executor · Audit

Error handling

Preflight the tenant's ledger routing configuration (admin)

Authorizations

Query Parameters

Response