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 marketplace’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:
Component |
Description |
|---|---|
| Individual legal entity components | Enable users to manage their personal details and verification status. Users can enter personal details and upload required documents, view their current verification status, and update their information when necessary. |
| Terms of Service components | Allow users to manage the Terms of Service documents. Users can accept the latest Terms of Service documents, view the status, and download signed copies for their records. |
| Transfer Instrument components | Provide users with full control over their bank accounts. Users can create a new bank account (transfer instrument) using instant verification or document uploads, and manage existing accounts by adding, deleting, and viewing their corresponding verification statuses and error messages, if applicable. |
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 component type and a library version that suit your situation in the following sections.
Select a component type
Select the tab for the component you are interested in to view the relevant description and integration steps: