Knowledge Hub / Developer Center

Build on CoreFi.

One API surface across the core ledger, lending, onboarding, payments, tokenization and the AI workflow control plane. OAuth 2.0 and JWT, scoped permissions, signed webhooks, and a tool-calling layer your agents can talk to under the same governance as your operators.

See AI workflows
What you can build

One platform, one API surface.

CoreFi exposes the same primitives a bank operates on — accounts, ledger entries, customers, loans, payments, tokens, KYC cases, AI workflows — through a coherent REST + webhook surface. You can run a digital lender on top, modernize one banking journey alongside a legacy core, or wire AI agents into existing operations under the bank's permission and audit model.

The platform is the same for human integrators and AI agents: every call is authenticated, scoped to a permission set, evaluated against policy, executed through the core, and recorded in the audit log. There is no separate "AI lane" that bypasses controls.

Reference & SDKs

API reference and client libraries.

A reference portal and official SDKs are in active development. Until they are public, sandbox tenants get a versioned OpenAPI specification and integration guides delivered through your account.

API Reference Coming soon

Public OpenAPI portal covering accounts, ledger, customers, lending, onboarding, payments, tokens, AI workflows and webhooks. Today, the OpenAPI specification is shared with sandbox tenants on request — no public endpoint examples yet.

TypeScript SDK Coming soon

Typed client for Node.js and browser integrations, generated from the OpenAPI spec. Targeting first published release alongside the public reference portal.

Python SDK Coming soon

Pythonic client for backend services, data pipelines and agent runtimes. Generated from the same OpenAPI spec as the TypeScript SDK so contracts stay in lock-step.

Java SDK Coming soon

JVM client for institutions standardised on Java/Kotlin. Surfaces the same resources, scopes and pagination model as the other SDKs.

OpenAPI specification Available on request

Versioned OpenAPI 3.1 document is shared with sandbox tenants under NDA. It is the source of truth for the SDKs above and for any internal client generation you want to do today.

Postman collection Coming soon

Importable collection for ad-hoc exploration of the sandbox. Will track the same versions as the OpenAPI specification.

Sandbox

Test against a real, isolated tenant.

CoreFi sandboxes are full tenants — your own ledger, your own accounts, your own webhook endpoint, your own scoped credentials — running on the same code path as production, with synthetic data and no real value flow.

What's in it
Isolated tenant with seeded customers, accounts and ledger entries; sandbox OAuth client; signing key for webhooks; AI workflow examples wired to the same control plane as production.
What's not in it
No real money movement. No real KYC vendor calls (mocked). No connection to live counterparties. No production data of any kind.
How to request
Sandbox provisioning is gated today. Request access through the form and we will set up your tenant, share the OpenAPI specification and walk through the first integration.
Lifecycle
Sandboxes can be reset on request. Production cut-over reuses the same client model and scope structure — what passes in sandbox keeps passing in production.
Authentication

OAuth 2.0 with JWT bearer tokens.

Every CoreFi request is authenticated. The platform issues short-lived JWT access tokens via OAuth 2.0; the same token model covers human operators, server-to-server services and AI agent runtimes.

01

Client credentials

Server-to-server flow for backend services and scheduled jobs. The client authenticates with its credentials and receives a short-lived JWT access token bound to a fixed scope set.

02

Authorization code + PKCE

User-facing flow for operator dashboards and customer-facing channels. Returns an access token plus a refresh token; the access token carries the user's role and the session's scope set.

03

JWT bearer (assertion)

Federated flow for trusted services that already authenticate users — including AI agent runtimes. The caller presents a signed assertion; CoreFi exchanges it for an access token bound to the agent's scope and the principal it is acting on behalf of.

Tokens are validated on every request. Signing keys are rotated and published through a JWKS endpoint. Tokens carry the principal, the scope set, the tenant, the issuance time and a unique identifier so every call can be tied back to a specific session in the audit log.

Permission model

Scopes, roles and policy gates.

Permissions are explicit and layered. A token cannot call an API it has not been scoped to. Beyond scopes, the bank's policy gates evaluate every action before it touches the ledger.

01

Scopes

Each token carries a fixed scope set such as accounts.read, ledger.write, kyc.cases.review, workflows.run. Scopes are granted at the client level and can be narrowed further per session. Calls outside the scope set are rejected before reaching the resource.

02

Roles

Roles bundle scopes for human operators (reviewer, underwriter, treasurer, MLRO, admin) and for service principals. Roles are tenant-configurable; a bank can change what "reviewer" can do without redeploying any client.

03

Policy gates

Even when scopes pass, the platform evaluates each action against configurable policy: transaction limits, customer-segment rules, jurisdictional restrictions, AML and sanctions checks, model-output guardrails. Failed gates either block or escalate to a human approver.

04

On-behalf-of

Tokens can carry an acting principal — the human or system that delegated the action — distinct from the authenticated client. The audit log records both, so an agent acting on behalf of an operator stays attributable end-to-end.

05

Tenant isolation

Every token is bound to a single tenant. Cross-tenant calls are rejected at the token layer; multi-tenant integrations request one client per tenant and switch the token, never the URL.

06

Audit

Every authenticated call writes a record: principal, on-behalf-of, scope set, gate decisions, side effects on the core, and any human approvals along the way. Exportable for internal review, external audit and supervisory requests.

Webhooks

Signed events, replayable, ordered per resource.

CoreFi pushes platform events to your endpoint as soon as they are committed. Every payload is signed; you verify the signature before you act. Delivery is at-least-once with monotonic sequencing per resource so you can deduplicate safely.

Account & ledger events

Account opened, status changed, balance updated, journal entry posted, statement closed. The same events that drive the operator dashboards are available to your services.

Lending events

Application received, decisioned, funded, repaid, written off; collateral changes; collection events. Tied to the underlying credit memo so your CRM stays in sync with the core.

Onboarding & KYC events

Case created, escalated, decisioned, periodic-review due. Carry the decision rationale and a reference to the structured evidence packet for downstream review systems.

Payment events

Payment received, released, returned, settled, reconciled. Enough metadata to drive a customer notification or a treasury reconciliation without an additional round trip.

Token & custody events

Token issued, transferred, redeemed, frozen; custody key events; reserve attestation milestones. Useful where tokenization sits next to the core ledger as a separate system of record.

AI workflow events

Workflow started, plan proposed, policy gate decision, action executed, escalation raised, human decision recorded, workflow closed. Same audit-grade detail as the in-product reviewer view.

Signature
Each delivery includes an HMAC signature over the payload and a timestamp. Verify both before trusting the body. Signing keys are rotated and listed alongside the OpenAPI specification.
Ordering
Per-resource monotonic sequence. Cross-resource ordering is not guaranteed; use the sequence number on the resource you care about.
Retries
Exponential backoff for non-2xx responses. After the retry budget, deliveries surface in a dead-letter queue you can replay from the dashboard or the API.
Replay
Re-deliver any historical event, or any range, on demand. Useful when you stand up a new consumer or recover from a downstream incident.
Agent tool-calling APIs

The same APIs, exposed as governed tools.

CoreFi publishes a catalog of tools — typed function definitions an AI agent can call — that map onto the same REST surface, scopes and policy gates as the rest of the platform. Whatever your agent is allowed to do, an operator with the same scope set could do too. Nothing more.

01

Tool catalog

Each tool is a typed contract: name, description, input schema, output schema, required scopes, policy gates that apply, and the human-approval shape if any. The catalog is queryable so an agent can discover only the tools its scope set allows.

02

Scoped agent tokens

An agent runtime authenticates as a service principal through the JWT bearer flow, optionally on behalf of an operator. Its token carries the agent's scope set; tools outside that set are not even visible.

03

Plan, check, act

Before a tool is executed, the platform runs the same lifecycle as the AI Workflows control plane: the agent's proposed call is validated, evaluated against policy, executed through the core, and recorded. Failed gates stop the call or escalate.

04

Approval-aware

Tools whose underlying action requires human approval do not block the agent runtime. The platform issues a structured "pending" result; once a human approves in the reviewer dashboard, the workflow resumes from the same step.

05

Model-agnostic

The catalog is published as JSON Schema and as native tool definitions for major providers (OpenAI / Anthropic / Gemini-style function calling). Swap the model or run several side-by-side without changing the contract.

06

Audit-grade

Every tool call is written to the same immutable workflow record as a human action: who called it, on whose behalf, with what input, which gates evaluated to what, and what changed in the core. Regulators get one record per case.

Status, releases, support

Operate against the platform with confidence.

Production tenants get visibility into platform health and an audit-friendly history of every change to the API surface. The public-facing surfaces below are being built out alongside the reference portal.

Status page Coming soon

Public uptime and incident history for the platform. Until the public page is live, sandbox and production tenants receive incident notifications through their account contact and through the operator dashboard.

Release notes Coming soon

Versioned changelog for the API surface, SDKs and AI workflow control plane. Until the public changelog is live, sandbox tenants receive release notes alongside the OpenAPI specification on each cut.

Versioning & deprecation

Breaking changes ship behind a new API version. Older versions are supported alongside the new one for a published deprecation window so you can migrate on your own schedule.

Support

Production tenants get a named integrations contact and an SLA-backed channel for incidents. Sandbox tenants get response on the next business day, or faster during an active integration.

Security disclosure

Responsible disclosure is welcome. Reach out through the contact form to receive the disclosure policy and a coordination channel.

Compliance & controls

Platform controls — encryption, residency, audit, RBAC, model governance — are documented on the security and compliance page; integrators inherit them automatically.

Get a sandbox and the OpenAPI spec.

Tell us what you want to build and we'll set up a sandbox tenant, share the OpenAPI specification, and walk through the first integration with an engineer.

See AI workflows →