---
title: "Onboard and verify users"
description: "Learn to move your users through the onboarding and verification process."
url: "https://docs.adyen.com/platforms/onboard-users"
source_url: "https://docs.adyen.com/platforms/onboard-users.md"
canonical: "https://docs.adyen.com/platforms/onboard-users"
last_modified: "2024-03-04T17:27:00+01:00"
language: "en"
---

# Onboard and verify users

Learn to move your users through the onboarding and verification process.

[View source](/platforms/onboard-users.md)

Your users' legal entity type and operating country determine the [required verification information](/platforms/onboard-users/onboarding-steps) 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.

* **Hosted onboarding**: Direct your users to a page hosted by Adyen, where Adyen manages the onboarding flow and user interface (UI). You can either have Adyen create the resources automatically by requesting them in your Customer Area (onboarding on invite), or create the resources yourself by making a few API calls (API-initiated hosted onboarding).
* **API-only onboarding**: Build your own UI and collect required user data. You make API requests to create resources and submit the user data to Adyen. This onboarding type gives you complete control over the user journey within your platform's environment.

The timing of when you need to collect this information depends on the [verification type](/platforms/verification-overview/verification-types) that applies to your case. After Adyen receives the information, the [verification process](/platforms/verification-overview) starts automatically.

## Requirements

If you have an [Adyen for Platforms](/adyen-for-platforms-model/) integration, there are no additional requirements, limitations, or preparations.

## Hosted onboarding

##### Hosted onboarding Postman flows

![](/user/pages/reuse/pfs-general/link-to-postman-flows/postman-icon.svg?decoding=auto\&fetchpriority=auto) [Try out Postman flows](https://www.postman.com/adyendev/workspace/adyen-flows/flow/6555da913826e900310ebeba) in your private workspace to test all the required API calls with your own credentials.

Hosted onboarding is our recommended solution for collecting the information needed to onboard your users. This option requires less integration effort, because your users provide their information directly on a page hosted by Adyen.

You can onboard the following [legal entity types](/platforms/verification-requirements/#legal-entity-type):

* [Organization](/platforms/verification-requirements/?tab=organization_1)
* [Individual](/platforms/verification-requirements/?tab=individual_2)
* [Sole proprietorship](/platforms/verification-requirements/?tab=sole_proprietorship_3)
* [Trusts](/platforms/verification-requirements/?tab=trust_4) (Only in Australia and New Zealand)

Adyen offers two different ways to implement hosted onboarding:

* **Onboarding on invite**: In your Customer Area, request Adyen to create an account holder for your user. You then create a hosted onboarding link to redirect your users to enter their information. Choose one of the following options:

  * Create a hosted onboarding link in your Customer Area to share it with your user after their account is created. Your user can securely access the hosted onboarding link with an SMS authentication. They then will be redirected to the Adyen-hosted page to provide their information.
  * Integrate the View Verification Status component into your user interface (UI). This component automatically creates a hosted onboarding link, redirects your user to the Adyen-hosted page to provide their information, and shows their verification status.

* **API-initiated**: Create resources and a hosted onboarding link by making API calls to several endpoints. After you create the link to the onboarding page, redirect your users to enter their information.

Choose the option that best suits your use case.

### Tab: Onboarding on invite

Onboarding on invite allows you to onboard users without integrating APIs for hosted onboarding. All actions are performed in your Customer Area, requiring minimal manual work from you.

In your Customer Area, [request Adyen to create an account holder](#resources) for your user. You then create a [hosted onboarding link](#ho-link) to redirect your users to enter their information.

When you request an account holder, Adyen automatically creates all required resources and configures the default payment methods for your user.

#### Resources and payment methods

The payment methods and stores are created after the `receivePayments` [capability](/platforms/verification-overview/capabilities/) is allowed. This means that information about the payment methods and stores becomes accessible in the Customer Area **only after** the user has completed the [verification process](/platforms/verification-overview).

Adyen creates the following resources for your user:

* Account holder
* Balance account
* Business line

* Legal entities

* Payment methods

* Stores

Adyen sets up the following payment methods for your user. The [availability of these payment methods](https://www.adyen.com/payment-methods) depends on the country/region where the user's legal entity is registered.[]()

* AliPay
* Amex
* Bancontact
* China UnionPay (CUP)
* Discover
* Eftpos

* Girocard

* iDeal

* JCB

* Maestro

* Mastercard

* Visa

After onboarding your user, you can [add additional stores](/platforms/manage-stores?tab=CA-1_1) and [request additional payment methods](/platforms/payment-methods/customer-area).

#### Hosted onboarding link

The following shows the possible options for creating a hosted onboarding link during the onboarding on invite flow.

If you choose API-initiated hosted onboarding and generate a link using the LEM API, you need to:

* Configure the page [settings](https://docs.adyen.com/api-explorer/legalentity/latest/post/legalEntities/\(id\)/onboardingLinks#request-settings) to show the relevant PCI questionnaires that the user needs to sign.
* Handle the redirect to the hosted onboarding page.
* Set up your server to get updates about the verification status and results.

See the [onboarding steps](/platforms/onboard-users/onboarding-steps) for API-initiated hosted onboarding.

### Tab: API-initiated

The API-initiated hosted onboarding requires integrating the [Legal Entity Management API](https://docs.adyen.com/api-explorer/legalentity/latest/overview) and [Configuration API](https://docs.adyen.com/api-explorer/balanceplatform/latest/overview). You must make several API calls to create and customize the resources required to generate the Adyen-hosted onboarding page.

You can also [customize](/platforms/onboard-users/customize-hosted-onboarding) the theme, the language, and the user permissions of the hosted onboarding page.

See [onboarding steps](/platforms/onboard-users/onboarding-steps) for more details.

### Supported countries and regions

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\
Singapore\
Slovakia\
Slovenia\
Spain\
Sweden\
Switzerland\
United Kingdom (including Isle of Man & Jersey)\
United States (including Puerto Rico)

### Instant bank account verification in hosted onboarding

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        | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") |                                                                                             |
| Belgium        | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") |                                                                                             |
| Canada         | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") |
| Denmark        | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") |                                                                                             |
| Estonia        | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") |                                                                                             |
| Finland        | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") |                                                                                             |
| France         | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") |
| Germany        | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") |
| Ireland        | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") |                                                                                             |
| Italy          | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") |                                                                                             |
| Latvia         | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") |                                                                                             |
| Lithuania      | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") |                                                                                             |
| Netherlands    | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") |
| Norway         | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") |                                                                                             |
| Portugal       | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") |
| Poland         | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") |
| Spain          | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") |
| Sweden         | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") |
| United Kingdom | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") |
| United States  | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") |

To see an example of the entire hosted onboarding flow, you can watch a video here:

Embedded video (Vimeo): <https://player.vimeo.com/video/844529799?h=0504e3c3d0>

Embedded video (Vimeo): <https://player.vimeo.com/video/844529828?h=47c0053c04>

### Autofill individual details using ID documents in hosted onboarding

This feature is only available if you are using [onboarding v3 or v4](/platforms/onboard-users/onboarding-versions/)

Users filling in their personal details can now scan or upload their ID document in the hosted onboarding page to add this information. This ensures that the information matches the document and improves verification pass rates.

Only ID documents that contain [Latin characters](https://en.wikipedia.org/wiki/Latin_alphabet) are supported.

After scanning or uploading their ID document, the user can confirm their information before submitting it to Adyen.\
![](/user/pages/reuse/pfs-onboarding/landing-page/hosted/Id-capture.png)

To test this feature, use the following [sample document](https://documentation.onfido.com/images/sample_driving_licence.png).

### Guided flow to add decision makers for organizations in hosted onboarding

This feature is only available if you are using [onboarding v3 or v4](/platforms/onboard-users/onboarding-versions/)

Users can answer a series of questions to ensure that they select the correct role for the decision makers for their organization. Decision makers include [ultimate beneficial owners, controlling persons, and signatories](/platforms/verification-requirements/?tab=organization_0_1#identify-ubos).

![](/user/pages/reuse/pfs-onboarding/landing-page/hosted/decision-makers.png)

## API-only onboarding

With API-only onboarding, you need to build the UI for your platform 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](https://docs.adyen.com/api-explorer/legalentity/latest/overview) and the [Configuration API](https://docs.adyen.com/api-explorer/balanceplatform/latest/overview). You can onboard users operating in any of the [countries and regions where Adyen for Platforms is supported](/platforms#supported-countriesregions).

To build your integration more quickly, you also can embed an [Onboarding component](/platforms/onboard-users/components) into your UI to let your users enter their data. These components use the entered data to create the relevant resource. This means you do not need to make an API request to create the resource yourself.

## Next steps

[required](/platforms/onboard-users/onboarding-steps)

[Onboarding steps](/platforms/onboard-users/onboarding-steps)

[See the required verification information for your users and how to submit it to Adyen](/platforms/onboard-users/onboarding-steps)

[Customize hosted onboarding](/platforms/onboard-users/customize-hosted-onboarding)

[Learn how to customize your hosted onboarding page](/platforms/onboard-users/customize-hosted-onboarding)
