No momento, esta página não está disponível em português
Issuin icon

Onboarding components

Use Adyen's prebuilt UI components to collect information from your users as part of your onboarding flow.

The Onboarding components are only compatible with the legal entities created with v3 or v4 of the Legal Entity Management API.

To onboard and verify users, you need to create a user interface (UI) to collect user data. To speed up building your integration, Adyen offers Onboarding components. You can integrate these components into your platform’s UI to let your users enter their data. The component then uses the entered data to create the relevant resource. This means you do not need to implement the API call to create the resource yourself.

We recommend using the Onboarding components in your API-only onboarding flow to reduce engineering efforts and speed up implementation. It is important to note that the Onboarding components only cover certain functionality, and you still need to implement API calls for other parts of your API-only onboarding flow.

Here are some scenarios where the Onboarding components can be particularly useful:

  • You are developing your UI to onboard users with API-only onboarding and want to speed up the process.
  • You have already built your UI to onboard users with API-only onboarding and want to reduce the effort required to maintain your code.
  • You are using hosted onboarding to onboard users and want to let users manage their submitted data directly in your UI.

You can integrate the following Onboarding components:

  • Transfer Instrument components: provide users with full control over their bank accounts (transfer instruments). Users can create new accounts using instant verification or document uploads, and manage existing ones, including viewing verification statuses. By integrating these components, your users can enter bank details directly, which automatically creates the transfer instrument resource without requiring you to make any separate API calls.

The guidance and features available may differ based on the library version in use. We recommend using the latest library version to take advantage of the newest features and improvements.

Ensure you select a version in the next section before starting your integration.

See also