Skip to main content
GET
Preflight the tenant's ledger routing configuration (admin)

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Parámetros de consulta

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.

Ejemplo:

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

Respuesta

OK

documentState
enum<string>
requerido

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.

Opciones disponibles:
sentinel,
empty,
bindings,
invalid
Ejemplo:

"bindings"

judicialAccountsDocumentState
enum<string>
requerido

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.

Opciones disponibles:
sentinel,
empty,
entries,
invalid
Ejemplo:

"entries"

lines
object[] | null
requerido

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.

organizationsDocumentState
enum<string>
requerido

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.

Opciones disponibles:
sentinel,
empty,
entries,
invalid
Ejemplo:

"entries"

ready
boolean
requerido

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.

Ejemplo:

false