Your users' legal entity type and operating country determine the required verification information you need to collect from your users. You can use Adyen's Hosted onboarding or build your own UI to collect information from your users. After Adyen receives the information, the verification process starts automatically.
You can choose from the following types of onboarding:
- Hosted onboarding: this option involves implementing fewer API calls and allows you to redirect the user to an Adyen page. On this page, Adyen manages the user onboarding flow and user interface (UI).
- API-only onboarding: with this option, you need to develop your own UI and make API calls to gather and send user data to Adyen. This onboarding type gives you complete control over the user journey within your platform's environment.
Hosted onboarding
Hosted onboarding Postman flows
Try out Postman flows in your private workspace to test all the required API calls with your own credentials. Select your business model: marketplace or platform.
Hosted onboarding is our recommended solution for collecting the information needed to onboard your users. This option requires less effort to set up because your users provide their information directly on a page hosted by Adyen. You only need to make a few API calls to the Legal Entity Management API (LEM API) to create legal entities and account holders for your users and redirect them to the Adyen-hosted page.
If necessary, you can customize the theme, the language, and the user permissions of the hosted onboarding page.
If your users need to accept Adyen's Terms of Service, we included this step on the hosted onboarding page.
See supported countries/regions
You can onboard the following legal entity types:
- Organization
- Individual
- Sole proprietorship
- Trusts (Only in Australia)
You can use hosted onboarding in the following locations where your users are operating.
Australia
Austria
Belgium
Bulgaria
Canada
Croatia
Cyprus
Czech Republic
Denmark
Estonia
Finland
France
Germany
Gibraltar
Greece
Guernsey
Hong Kong
Hungary
Ireland
Italy
Latvia
Liechtenstein
Lithuania
Luxembourg
Malta
Netherlands
New Zealand
Norway
Poland
Portugal
Romania
Slovakia
Slovenia
Spain
Sweden
Switzerland
United Kingdom (including Isle of Man & Jersey)
United States (including Puerto Rico)
Instant bank account verification
For some locations and legal entity types, your users can choose to instantly verify their bank account details in your hosted onboarding page. They are prompted to log in to their online banking environment and confirm their account details. Their bank account is then verified within seconds without them needing to provide a bank statement.
See supported countries/regions
This feature is currently only available for the following locations and legal entity types.
| Country/region | Individuals | Organizations |
|---|---|---|
| Austria |  |
|
| Belgium | |
|
| Canada | |
|
| Denmark | |
|
| Estonia | |
|
| Finland | |
|
| France | |
|
| Germany | |
|
| Ireland | |
|
| Italy | |
|
| Latvia | |
|
| Lithuania | |
|
| Netherlands | |
|
| Norway | |
|
| Portugal | |
|
| Poland | |
|
| Spain | |
|
| Sweden | |
|
| United Kingdom | |
|
| United States | |
|
To see an example of the entire hosted onboarding flow, you can watch a video here:
API-only onboarding
With API-only onboarding, you need to build your own UI where you collect data from your users. You then need to submit the collected data to Adyen by making requests to the Legal Entity Management API and the Configuration API.
To build your integration more quickly, you also can embed the Onboarding components into your 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 make an API request to create the resource yourself.