Onboarding Flow
To establish a connection and retrieve data from Your Customer's Accounting System, you must invite them to use the Onboarding Flow.
Ways to embed the Onboarding Flow
Embed it within Your Platform
You can embed the Onboarding Flow in an iframe, so that you can control the look and feel of the size of the Onboarding Flow, and have control over the area outside the iframe in whatever way you wish.
Redirect to the Onboarding Flow
You can redirect your customer to the Onboarding Flow from Our Platform, and once they are finished it can automatically redirect back to Your Platform.
Direct Link
If you want to share a link to the Onboarding Flow with your customer (e.g. via an email) you must first direct them to Your Platform from where you can generate a One-Time Code, and then redirect them to the Onboarding Flow.
You should not share a direct link to the Onboarding Flow except from within Your Platform. If you share a direct link via another method (e.g. email), the One-Time Code could expire, or be used become invalidated by email scanners or thumbnail previews, causing unexpected behaviour.
Parameters
One-Time Code (required)
Used to authenticate Your Customer.
Redirect back to Your Platform (optional)
If you wish to let your Your Customer return to Your Platform at the end of the Onboarding Flow, you can do so by including the query parameter redirecturl in the URL.
Control the redirect delay (optional)
You can control whether we redirect automatically back to Your Platform, and how long to wait for this to happen, using redirectdelay in the URL.
Last updated
Was this helpful?