Quick Start

This guide obtains an access token, retrieves the client creation schema for your integration, onboards a client, and requests an account.

Before you start

You need:

the BaaS API base URL for your environment;

an integrator username;

the matching secret key;

a unique client identifier from your own system;

a unique account identifier from your own system.

The examples use shell variables. Replace every value in angle brackets.

1. Set the base URL

The base URL includes the Child Brand Integration service path:

2. Request an access token

The response contains the bearer token and its lifetime:

{
  "accessToken": "<token>",
  "tokenType": "Bearer",
  "expiresIn": 3600
}

Store the token for the next requests:

Keep credentials and tokens in server-side systems. Do not expose them in browser or mobile application code.

See Authentication for token renewal and 401 Unauthorized handling.

3. Get the client creation schema

The required onboarding fields depend on your integration configuration. Request the current JSON Schema before you build a client payload:

Use type=Business for a company. Read the schema's required, properties, and enum values. The request body must include all required fields and must match the returned types.

4. Onboard a client

Create client.json from the schema returned in the previous step. It must include:

type, with the value allowed by the schema;

externalId, with a stable identifier from your system;

every other field listed in the schema's required array.

Submit the file:

A successful response contains the Framnex client identifier:

{
  "id": "<client-id>"
}

Store the identifier:

Client onboarding is asynchronous. Check the client state until it becomes Active, or process the corresponding webhook:

Do not request an account while the client is still Pending.

5. Open an account

The response contains the account identifier:

{
  "id": "<account-id>"
}

The account is opened in the create-account request. Store the account identifier for subsequent requests:

Bank details are provisioned asynchronously and may not be available immediately after account creation. You can retrieve the account when you need its current data:

You now have a client and an account identifier for the next supported flows. If a specific flow depends on bank details, wait until those details are available.

Next steps

Your client and account are now created. In the Guides folder:

use Create an outgoing transfer for the money movement flow;

use Handle webhooks before production transfers so your integration can react to asynchronous state changes;

use Onboard a client and Open an account as focused references for the two onboarding steps above.

For exact request and response fields, continue to use the generated API Reference as the source of truth.

Before you start#

1. Set the base URL#

2. Request an access token#

3. Get the client creation schema#

4. Onboard a client#

5. Open an account#