Skip to content

User onboarding

This guide walks you through onboarding a user in the Investment API. It includes user creation and regulatory identifiers.

This guide focuses on adding individual users. For information on adding businesses, refer to the Business accounts section.

Prerequisites

  • Authentication scopesusers:admin

    For more information, refer to Authentication scopes.

  • Webhook handler ready — Set up a webhook endpoint to listen for user lifecycle events.

    For more information, refer to Implementing webhooks.

  • You can start onboarding users as soon as you have completed the steps listed in the "Getting started" tutorial.

  • Support for information on the user’s tax residency and the Common Reporting Standard (CRS) is currently under development and will follow soon. Currently, we only onboard users that are non-US persons.

Implementation steps

Read the next chapters, in which we describe step by step how you can onboard a user.