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

Onboard and verify users

Learn to move your users through the verification process.

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.

Hosted onboarding: Direct your users to a page hosted by Adyen, where Adyen manages the onboarding flow and user interface (UI). You need to implement a few API calls to create the resources.

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.

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 integration effort, because your users provide their information directly on a page hosted by Adyen.

You need to make a few API calls to the Legal Entity Management API and Configuration API to create and customize the resources required to generate the Adyen-hosted onboarding page.

You can also 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 include this step on the hosted onboarding page.

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.

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:

Autofill individual details using ID documents in hosted onboarding

This feature is only available if you are using onboarding v3 or v4

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 are supported.

After scanning or uploading their ID document, the user can confirm their information before submitting it to Adyen.

To test this feature, use the following sample document.

Guided flow to add decision makers for organizations in hosted onboarding

Limited availability
This feature is currently only available in your test environment if you are using onboarding v3 or v4

Users are now able to 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.

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 Onboarding 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.

Onboarding v4 requirements

The following requirements apply if you want to issue cards to your users.

Business lines

You must create business lines to issue cards to your users. To submit this information to Adyen, make a POST /businessLines request, specifying the service as issuing. In your request, specify the industry code.

Source of funds

Only applicable for business accounts and card issuing.

Adyen is required to verify the source of funds (SOF) used to fund an account. This requirement is applicable for both card issuing and business accounts.

Depending on the type of funds, we may request additional documents as proof. We strongly recommend that you have these documents available before starting in order to speed up this process.

To submit this information to Adyen, make a POST /businessLines request, specifying the service as either:

banking for business accounts
issuing for card issuing

If the source of funds was processed through Adyen, set the sourceOfFunds.adyenProcessedFunds to true. If the source of funds was not processed through Adyen, set the sourceOfFunds.adyenProcessedFunds to false. You must then include the sourceOfFunds.type and sourceOfFunds.description. The description must state the origin of the source of funds.

The following table shows the accepted funding sources and the required documents for each type, if requested. If the type of accepted document has a listed date requirement, the document must meet this requirement.

Type of Source of Funds	`businessLines.sourceOfFunds.type` API value	Documents must show	Examples of accepted documents
Business earnings processed through Adyen	Set `businessLines.adyenProcessedFunds` to true	N/A	No supporting document is required
Previous business earnings	business	Name of company Amounts earned Description of business activity	Latest accounts (issued within the last financial year) Annual Statements (within 12 months) Latest tax filing (issued within the last year) Letter from accountant (signed and dated within 12 months) Recent Invoices (last 3 months)
(Previous) employment	employment	Your business name Date document was issued Bank logo/name (for bank statement) Employer’s name (for payslips)	Last 3 months of bank statements Last 3 months of payslips
Cryptocurrency	cryptocurrencyIncome	Your business name Date document was issued (no older than 12 months) Name of Crypto-exchange Name of coin	Proof of ownership of wallet Statement of transaction history (showing crypto) Latest tax report (showing crypto) (no older than 12 months)
Investments (dividends)	dividendIncome	Your business name The date your business received the money The amount received The type of investments Names of the parties involved	Contract specifying dividends Latest tax returns of the company (no older than 12 months) Investment certificate Broker statement (issued within 3 months)
Loans	loans	Your business name Amount you borrowed The date you received the money Name of the lender Address of the lender Purpose of the loan	Loan agreement Loan statement (no older than 12 months)
Subsidies / Grants	financialAid	Amount of Subsidy / Grant Providers(s) of Subsidy / Grant Time Period	Confirmation of Subsidy / Grant Subsidy Receipt
Third Party Funding (capital investments)	thirdPartyFunding	Your business name The date your business received the money The amount received Names of the parties involved Addresses of the parties involved Signatures of the parties involved Payment purpose	Investor contracts Investor memoranda Notarized statements (no older than 12 months) Partnership agreement
Property Sale	assetSale	Date money was received Amount you received Address (if applicable) Description of property	Proof of ownership (notarized) Signed letter from the solicitor / estate agent (no older than 12 months) Copy of contract of sale Tax declaration (no older than 12 months) Title deed (notarized)
Rental Income	rentalIncome	Amount received Address Name of parties to the agreement	Rental Agreement Proof of Ownership
Donations / Gifts	donations	Amount received Date of transfer Full name of donor	Original or certified copy of grant
Royalty Income	royaltyIncome	Description of (intellectual) property Amount received	Royalty agreement Tax declaration (no older than 12 months)
Gambling / Lottery	gamblingWinnings	Amount won Date of winning Location / Site	Proof of Winnings Win Report Win/Loss Statement (issued within 3 months) Tax declaration that shows winnings (issued within 12 months)
Inheritance	inheritance	Name of person who made the will Amount received / Value of estate Date received Name of benefactor	Certificate of inheritance A grant of probate Letter from solicitor / notary (no older than 12 months) Signed copy of the will
Pension	pensionIncome	Amount to be received Legal Name of recipient	Pension slip (no older than 12 months) Letter from previous employer Pension statement form (no older than 12 months)
Insurance / Settlement	insuranceSettlement	Amount of settlement Legal name of recipient Date received	Court order Letter from lawyer / solicitor Letter from insurer

Próximas etapas

obrigatório

Onboarding steps

See the required verification information for your users and how to submit it to Adyen

Customize hosted onboarding

Learn how to customize your hosted onboarding page