BaaS API overview#
The BaaS API is for platforms that provide financial services to their own clients. Your platform remains the integrator, while each individual or company that you onboard becomes a separate client with its own accounts.Use the BaaS API when you need to:onboard individual or business clients;
open and retrieve accounts for those clients;
request exchange rates between accounts;
create and track outgoing transfers;
receive and inspect webhook deliveries.
Resource model#
The main resources form this hierarchy:1.
Client represents an individual or company served by your platform.
2.
Account belongs to one client and holds funds in one currency.
3.
Exchange rate provides a rate between a sell account and a buy account.
4.
Transfer moves funds from an account and is tracked separately from the request that created it.
5.
Webhook delivery reports asynchronous changes and can be inspected or retried.
Client onboarding#
Client onboarding is specific to your Framnex configuration. The allowed client types and required fields can differ by integrator.Before you create a client, request the current creation schema for Individual or Business. Build the client payload from the returned JSON Schema instead of relying on a fixed list of fields.Client creation is asynchronous. A successful request returns a client identifier, but it does not mean that onboarding is complete. Read the client state or process the related webhook until the client becomes active.Account opening#
Open an account only after the client is active. Supply your own stable external identifier, the Framnex client identifier, and an ISO 4217 currency code.Account opening is also asynchronous. Track the account until its state becomes Opened before you use it in a transfer.Authentication#
Exchange the integrator username and secret key at POST /auth/token. Send the returned access token with protected requests:Tokens expire. Request a new token based on the expiresIn value returned by the authentication endpoint.Next step#
Continue with the BaaS API Quick Start to obtain a token, inspect the client creation schema, onboard a client, and request an account.Modified at 2026-09-21 18:01:20
