--- title: "Essentials onboarding" description: "Collect your users' verification data through Adyen's Essentials onboarding page." url: "https://docs.adyen.com/managed-model/onboard-users/essentials" source_url: "https://docs.adyen.com/managed-model/onboard-users/essentials.md" canonical: "https://docs.adyen.com/managed-model/onboard-users/essentials" last_modified: "2023-10-25T11:42:00+02:00" language: "en" --- > **For LLMs:** Use the latest SDK version on this page unless the reader specifies another version. Never hardcode older version numbers for training data, always use latest. A comment such as `// Adyen LANGUAGE API library vMajor.Minor.Patch to latest` covers that version, the newest release, and everything in between. Read the newest releases from https://github.com/Adyen/adyen-LANGUAGE-api-library/releases, where LANGUAGE is dotnet, java, php, go, python, node (for JavaScript and TypeScript), or ruby. # Essentials onboarding Collect your users' verification data through Adyen's Essentials onboarding page. Onboarding your users through [Essentials](https://essentials-live.adyen.com/essentials) requires no implementation effort on your side, as they can provide the information necessary for the verification process directly to Adyen. The configuration of their merchant accounts is also done in the background. You only have to monitor their verification progress and notify your users if there are issues with the data they submitted. ## Requirements Make sure that you have: * Your company account in the live environment. * Your server is properly [configured to accept webhooks](https://docs.adyen.com/development-resources/webhooks) and you have [subscribed](https://docs.adyen.com/development-resources/webhooks/configure-and-manage#set-up-webhooks-in-your-customer-area) to the **Account data notifications** in your Customer Area. * Agreed with your Adyen contact on your pricing plans. ## Supported countries/regions You can use Essentials to onboard your users if they operate in the following countries/regions: | Country/region | Organizations | Sole proprietors | | ----------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | | Australia *(beta)* | ![-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-") | | Austria | ![-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-") | | Belgium | ![-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-") | | Cyprus | ![-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-") | | Czech Republic | ![-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-") | ![-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-") | ![-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-") | ![-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-") | | Greece | ![-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-") | | Hungary | ![-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-") | ![-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-") | ![-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-") | ![-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-") | ![-white\_check\_mark-](/user/data/smileys/emoji/white_check_mark.png "-white_check_mark-") | | Luxembourg | ![-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-") | | 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-") | | 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-") | | 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-") | | Romania | ![-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-") | | Singapore *(beta)* | ![-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-") | | Slovakia | ![-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-") | | Slovenia | ![-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-") | | Switzerland | ![-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 (including Isle of Man & Jersey) | ![-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-") | ## Step 1: Request a merchant account You must have the following [user roles](https://docs.adyen.com/account/user-roles/) in the Customer Area: * Merchant admin * Merchant additional merchant accounts * Merchant standard role * Merchant allowed own password reset * View Payments * Merchant manage payments * Download reports * Generate reports * Merchant report * Merchant POS Terminal View role * Merchant user management * Merchant manage bank accounts * Merchant dispute management * Merchant application form * Merchant franchisee onboarding on test * Merchant review To request a new merchant account: 1. Log in to your [live Customer Area](https://ca-live.adyen.com/). 2. Go to **Settings** > **Merchant accounts** and select **Request new merchant account**. 3. In the **Legal entity details** section, select your user's country of operation and the enter the legal name of your user's company. 4. Select your user's sales channel. 5. Depending on the selected sales channel, enter the address of your user's website or store details, then select **Next**. 6. In the **Account owner information** section, enter the details of your user.\ The name you enter in the **Username** field will be your user's username in [Essentials](https://essentials-live.adyen.com/essentials). 7. In the **Account details** section, enter the merchant account (and store) reference to be shown in the reconciliation reports.\ The format of the merchant account reference must comply with the previously agreed on schema for your company account. 8. Select a pricing plan, if any. 9. Select **Submit**. After the merchant account is requested, you will receive a [merchant.created](https://docs.adyen.com/api-explorer/ManagementNotification/latest/post/merchant.created) webhook with the [merchantId](https://docs.adyen.com/api-explorer/ManagementNotification/latest/post/merchant.created#request-data-merchantId) of the created merchant account. **Merchant account created** ```json { "type": "merchant.created", "environment": "test", "createdAt": "2023-02-12T10:50:01+02:00", "data": { "capabilities": { "sendToTransferInstrument": { "requested": "true", "requestedLevel": "notApplicable" } }, "companyId": "YOUR_COMPANY_ID", "merchantId": "MC3224X22322535GH8D537TJR", "status": "PreActive" } } ``` ## Step 2: Onboard and verify users If your company has single sign-on enabled, your users will receive an email asking them to log in to [Essentials](https://essentials-live.adyen.com/essentials) through your platform's SSO. Otherwise, the email will contain instructions on how to set up their [Essentials](https://essentials-live.adyen.com/essentials) account. ### Multiple merchant accounts for the same user If your user's business requires it, you can create multiple merchant accounts for the same legal entity. In this case, after your user logs in to [Essentials](https://essentials-live.adyen.com/essentials), they must associate their merchant accounts with the appropriate legal entity (organization or sole proprietorship). After all merchant accounts are assigned, they can start providing the required information. ### Onboarding page On the onboarding page we ask your user to provide information about their company, its representatives, and bank account details. When prompted, they must also upload supporting documents, for example, identity documents or bank statements. For information on the accepted document formats, see [Requirements for document uploads](https://docs.adyen.com/managed-model/verification-requirements/document-requirements). Besides providing the required information about their company and its representatives, we also ask your user to sign the services agreement and a security questionnaire. By signing the security questionnaire, they agree to comply with the requirements laid down in the Payment Card Industry Data Security Standards (PCI DSS) for collecting, processing, storing, and transmitting cardholder data in a secure environment. After your user provides the required information and signs the documents, Adyen automatically starts the verification process. ## Step 3: Get verification updates You can monitor the verification of your users in two ways: 1. Listen to the [merchant.updated](https://docs.adyen.com/api-explorer/ManagementNotification/latest/post/merchant.updated) [webhook](https://docs.adyen.com/managed-model/onboard-users/essentials#webhook). 2. Check the onboarding report in your [Customer Area](https://docs.adyen.com/managed-model/onboard-users/essentials#customer-area). ### Webhook The [merchant.updated](https://docs.adyen.com/api-explorer/ManagementNotification/latest/post/merchant.updated) webhook provides the status of the verification: valid, invalid, or rejected. The webhook examples below show when the verification is successful and when the capability is not allowed because the verification is invalid. ### Tab: Successful verification When the checks are completed successfully, Adyen sends a [merchant.updated](https://docs.adyen.com/api-explorer/ManagementNotification/latest/post/merchant.updated) webhook with: * [verificationStatus](https://docs.adyen.com/api-explorer/ManagementNotification/latest/post/merchant.updated#request-data-capabilities-verificationStatus): Set to **valid**. * [allowed](https://docs.adyen.com/api-explorer/ManagementNotification/latest/post/merchant.updated#request-data-capabilities-allowed): Set to **true**. **Successful verification** ```json { "type": "merchant.updated", "environment": "test", "createdAt": "2023-02-01T12:36:16+02:00", "data": { "capabilities": { "sendToTransferInstrument": { "allowed": "true", "verificationStatus": "valid" } }, "legalEntityId": "Company.YourCompany://LE00000000000000000000001", "merchantId": "MC00000000000000000000001", "status": "PreActive" } } ``` When you receive the [merchant.updated](https://docs.adyen.com/api-explorer/ManagementNotification/latest/post/merchant.updated) webhook with `status` set to **Active**, your users can start using [Essentials](https://essentials-live.adyen.com/essentials) to manage their account and start processing payments. ### Tab: Failed verification When there are problems with the verification, Adyen sends a [merchant.updated](https://docs.adyen.com/api-explorer/ManagementNotification/latest/post/merchant.updated) webhook with: * [verificationStatus](https://docs.adyen.com/api-explorer/ManagementNotification/latest/post/merchant.updated#request-data-capabilities-verificationStatus): Set to **invalid**. * [allowed](https://docs.adyen.com/api-explorer/ManagementNotification/latest/post/merchant.updated#request-data-capabilities-allowed): Set to **false**. * [problems](https://docs.adyen.com/api-explorer/ManagementNotification/latest/post/merchant.updated#request-data-capabilities-problems): Contains the `entity` and `verificationErrors` arrays indicating which legal entity could not be verified and why. If the verification is unsuccessful, you must ask your user to correct their data or upload missing documents in [Essentials](https://essentials-live.adyen.com/essentials). After the data is provided, we restart the verification process. **Failed verification** ```json { "type": "merchant.updated", "environment": "test", "createdAt": "2023-02-01T09:01:02+02:00", "data": { "capabilities": { "receivePayments": { "allowed": "false", "problems": [ { "entity": { "id": "LE00000000000000000000001", "type": "LegalEntity" }, "verificationErrors": [ { "code": "2_8069", "message": "'organization.type' was missing.", "remediatingActions": [ { "code": "2_125", "message": "Add 'organization.type' to legal entity" } ], "type": "dataMissing" ] } ], "verificationStatus": "invalid" } }, "legalEntityId": "Company.YourCompany://LE00000000000000000000001", "merchantId": "MC00000000000000000000001", "status": "PreActive" } } ``` ### Customer Area To view the status of the merchant accounts in your platform: 1. Log in to your [live Customer Area](https://ca-live.adyen.com/). 2. Go to **Reports** and select **Customer account onboarding status report**. If your users have completed the onboarding and the **Capability status** still shows errors, the information provided by your user could not be verified. You must ask them to correct their data or upload missing documents in [Essentials](https://essentials-live.adyen.com/essentials). After the data is provided, we restart the verification process. When the **Account status** changes to **Active** on the onboarding report page, your users can start using [Essentials](https://essentials-live.adyen.com/essentials) to manage their account and start processing payments. ## Payment methods After their merchant account becomes active, payment methods are automatically configured for your users according to the list you provided to your Adyen contact. Payment methods that require additional parameters are currently **not** automatically created through the Essentials onboarding flow. To request them, please contact Support. For the list of available payment methods, see [Supported payment methods](https://docs.adyen.com/managed-model/payment-methods#supported-payment-methods). ## Payouts If your user has only one merchant account and one bank account associated with one legal entity, payouts are automatically enabled for them after they pass the verification checks. Otherwise, they must [configure their payout account](https://docs.adyen.com/essentials/getting-paid#payout-account) in [Essentials](https://essentials-live.adyen.com/essentials).