Requirements to start the flow.
Broker account
You must have a broker account (Tutorial here)
API key
Have an API key (Tutorial here).
A child user cannot create another user
Recommended endpoints.
Get the custom onboarding link
Send the link to the user or display it as an iframe in your application. Once
they complete the form, their user will be created and associated to yours
(broker) as a child (broker customer).
Check onboarding status
You can use the
userId
from the onboarding object to poll the user and get
its onboarding status (or you can use our webhooks).Disclaimer: All technical documentation is subject to the terms and
conditions, which apply supplementarily and take precedence over the
documentation.