NEXCLARA documentation
Guides to the functions that actually exist in the platform, an API reference generated from its contract, and an honest status of what remains to be built.
How to read the statuses
Every page carries the real status of the function it describes. A function that does not exist has no page.
The function described exists and is tested; the page also states what it does not do.
Part of the function exists; the page names precisely what is missing.
No page is published for this area: a function that does not exist has no guide.
Business functions
For credit, risk, administration and audit teams.
Getting started
Available- Welcome to the documentation
What this documentation covers, how it is built, and how to read the status of each page.
- Welcome to the documentation
Identity and sign-in
Available- Signing in and two-factor authentication
Activating an account from an invitation, enrolling the second factor, signing in and understanding session durations.
- Signing in and two-factor authentication
ADMIN
Available- Accounts, roles and invitations
Inviting the institution's staff, assigning roles, setting a delegation limit, suspending or deactivating an account from ADMIN.
- Accounts, roles and invitations
DESK
Available- Entering and submitting an application
Creating an application in DESK, following its completeness, saving it as a draft and submitting it to the decision engine.
- Entering and submitting an application
CORE
Available- Decision engine
The five stages of the CORE engine, its determinism, what it records at each evaluation and the reproduction of an earlier calculation.
- Decision engine
CLARITY
Under construction- Reading a result
The result screen of an evaluated application: recommended outcome, score and zones, key factors, missing data, levers and three explanation levels.
- Reading a result
LINK
Under construction- Importing applications from a CSV file
Versioned data contract, per-product template, upload, pre-validation without creating applications, confirmed import and provenance of each value.
- Importing applications from a CSV file
TRUST
Under construction- Decision evidence file
Exporting the verifiable evidence file of an evaluated application: canonical form, fingerprint manifest, instance signature and verification outside the platform.
- Decision evidence file
Policies
Under construction- Decision policy lifecycle
Creating a policy from a reference scorecard, setting its parameters, simulating it, submitting it and having it approved by another person.
- Decision policy lifecycle
Scoring
Under construction- Reference scorecards
The three scorecards delivered with the platform, their draft status and what the institution must set before any activation.
- Reference scorecards
Human decisions
Under construction- Deciding within your delegation
How a credit manager decides on an evaluated application, justifies a departure from the recommendation or escalates it to the next level.
- Deciding within your delegation
Technical documentation
For integration, architecture and security teams.
Architecture
Under construction- Architecture overview
The platform's planes, the isolation of each institution, the standard components used and the real state of deployments.
- Architecture overview
API reference
Available- API reference
Reference generated from the OpenAPI contract: operations, schemas, version.
- API reference
Authentication
Under construction- API authentication: tokens and credentials
How an API call is authenticated: a staff member's session token, second factor, step-up verification, machine credentials and correlation.
- API authentication: tokens and credentials
Errors
Available- Error protocol
Format of API error responses (RFC 9457), stable codes, categories and HTTP statuses, correlation identifier and confidentiality rules.
- Error protocol
Security
Under construction- Security measures
The protections actually in place: authentication, separation of institutions, chained audit trail, HTTP headers, secrets and delivery chain.
- Security measures
Documentation status — Every documentation area, including those that do not have a page yet.