Onboard a client

Use this flow to create an individual or business client with the BaaS API and wait until onboarding is complete.

Before you start

You need:

the BaaS API base URL for your environment;

a valid access token;

a stable client identifier from your own system;

the client information required by the creation schema for your integration.

If you do not have a token yet, start with Authentication.

1. Get the current client creation schema

The required onboarding fields are configuration-specific. Request the current OpenAPI 3.0 creation schema for the client type you want to create instead of hard-coding a fixed payload.

Use the client creation fields endpoint for Individual or Business:

Open the client creation fields endpoint

Read the returned schema's required, properties, and enum values before building the request body.

2. Build the client payload

Include:

the client type allowed by the schema;

a stable externalId from your own system;

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

Validate the payload against the current schema before you submit it. Requirements can differ between integration configurations.

3. Create the client

Submit the payload to the client onboarding endpoint:

Open the create client endpoint

A successful request returns a Framnex client identifier. Store that identifier together with your own externalId so you can reconcile the two systems.

4. Wait for onboarding to complete

Client creation is asynchronous. A successful create request does not mean the client is ready for account opening.

Check the current onboarding or profile state:

Open the client state endpoint

You can also process the corresponding webhook events. Do not request an account while the client is still Pending.

5. Continue when the client is active

When the client becomes Active, continue with Open an account in the Guides folder.

Common integration mistakes

Hard-coding onboarding fields instead of requesting the current creation schema.

Treating a successful create request as completed onboarding.

Losing the mapping between your externalId and the Framnex client identifier.

Attempting to open an account before the client reaches Active.

Before you start#

1. Get the current client creation schema#

2. Build the client payload#

3. Create the client#

4. Wait for onboarding to complete#

5. Continue when the client is active#