Skip to main content
The Lender console is a browser interface over the same API you can drive programmatically. It is a single environment-agnostic bundle: a deployment serves the console its configuration at start-up, so the same image points at any environment. This page documents the screens in the console.

Signing in


The console is a standard OpenID Connect client. It runs the authorization-code flow with PKCE straight from the browser to the identity provider you configure. Point it at the same Access Manager that issues the API tokens. The console exchanges the code for tokens, and refreshes them on demand before they expire. Tokens live in memory only. The console never writes them to browser storage. A reload or a new tab therefore starts from the sign-in screen rather than from a session someone else could read off the device. After the exchange the console asks Lender who the caller is, and takes the permissions it renders from that answer rather than from the token. The console does not show an action the identity may not perform, unless the deployment’s tokens carry no declared permissions at all. In that case, the console shows every action and lets the server refuse the ones the identity may not take. Signing out ends the local session and, when you configure the provider’s end-session URL, signs the user out at the provider too. Without that URL, the provider’s own session survives and the next sign-in skips the prompt.
Authentication ships turned off. In its default configuration the console establishes no session, shows every screen, and sends no bearer token. A deployment gets this state if nobody configures the identity provider. Turn it on and supply the authorization endpoint, the token endpoint, and the client id before the console reaches anyone. If you turn it on without those three, the console refuses loudly, with a misconfiguration screen rather than partial access.

What you can do in it


The console has no permission model of its own. Every action it offers goes through the same API operation, authorized by the same identity and tenant.

What the console does not do


The console has no screen for reconciliation, CNAB export, rescission capture, portability capture, or a consignado contract sheet and list. An account already in a portability-requested state still displays as one. There is no consignado contract screen because a consignado contract is not created in the console. A CLT contract arrives as a fact from the gateway once the client’s own systems have registered it with the payroll rail. Private and INSS lending is originated through the ordinary loan application above. See Consignado privado.

Next steps


Lender REST API

Everything the console does, driven programmatically.