{"title":"Hosted Onboarding Page","category":"Classic Platforms","creationDate":1776961628,"content":"<div class=\"sc-notice info\"><div>\n<p>This page is for classic Adyen for Platforms integrations. If you are just starting your implementation, refer to our <a href=\"\/pt\/adyen-for-platforms-model\">new integration guide<\/a> instead.<\/p>\n<\/div><\/div>\n<p>Send account holders to Adyen's Hosted Onboarding Page (HOP) where they provide additional information directly to Adyen. This is our recommended solution, because it requires less implementation effort on your side.<\/p>\n<p>With HOP, you can:<\/p>\n<ul>\n<li>Collect more information. For example, if the verification fails, account holders can use HOP to provide the new information required from them.<\/li>\n<li>Render the page in your account holder's preferred <a href=\"\/pt\/classic-platforms\/onboard-users\/hosted-onboarding-page\/customize-experience#change-page-language\">language<\/a>.<\/li>\n<li><a href=\"\/pt\/classic-platforms\/onboard-users\/hosted-onboarding-page\/hop-appearance\">Customize the page's appearance<\/a> in your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>.<\/li>\n<li><a href=\"\/pt\/classic-platforms\/onboard-users\/hosted-onboarding-page\/customize-experience\">Customize the hosted onboarding user experience<\/a> through the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Hop\/latest\/post\/getOnboardingUrl\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/getOnboardingUrl<\/a> endpoint.<\/li>\n<li>Receive account updates and verification results through notification webhooks.<\/li>\n<\/ul>\n<h3>How it works<\/h3>\n<div class=\"sc-columns\" style=\"columns:2 auto;-moz-columns:2 auto;column-gap:normal;-moz-column-gap:normal;\">\n<ol>\n<li>\n<p><a href=\"#create-account-holder\">Create an account holder<\/a> and present a link or a button to start the verification process.<\/p>\n<\/li>\n<li>\n<p>When the account holder selects the link or the button, provide Adyen with the account holder code and <a href=\"#get-hosted-onboarding-page-url\">get a one-time HOP URL<\/a>.<\/p>\n<\/li>\n<li>\n<p><a href=\"#handle-redirect\">Handle the redirect<\/a>. After the account holder is successfully redirected to the page, the session starts. The session is valid for 30 minutes. When the account holder provides their information, we send account updates through notification webhooks.<\/p>\n<p>The account holder is redirected back to your website after they finish providing their details or when the session expires.<\/p>\n<\/li>\n<li>\n<p><a href=\"#get-the-kyc-results\">Receive the verification results<\/a> through notification webhooks.<\/p>\n<\/li>\n<\/ol>\n<p>Play the video to see a sample HOP session.<\/p>\n<div style=\"text-align: right;\">\n<div class=\"hint--right\" data-hint=\"Sample HOP session\">\n<p><video controls=\"controls\" style=\"width: 360px;\" alt=\"\" src=\"\/user\/pages\/docs\/06.classic-platforms\/05.onboard-users\/01.hosted-onboarding-page\/hop-demo.mov?loading=auto&amp;decoding=auto&amp;fetchpriority=auto\"><source src=\"\/user\/pages\/docs\/06.classic-platforms\/05.onboard-users\/01.hosted-onboarding-page\/hop-demo.mov?loading=auto&decoding=auto&fetchpriority=auto\">Your browser does not support the video tag.<\/video><\/p>\n<\/div>\n<\/div>\n<\/div>\n<h2>Requirements<\/h2>\n<ol>\n<li>\n<p>Contact our <a href=\"https:\/\/ca-test.adyen.com\/ca\/ca\/contactUs\/support.shtml?form=other\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Support Team<\/a> to:<\/p>\n<ul>\n<li>Enable hosted onboarding for your platform.<\/li>\n<li>Provide a default return URL. The default return URL takes the account holder back to your website.<\/li>\n<\/ul>\n<\/li>\n<li>\n<p>Decide whether to collect all required information once in the beginning, or later in stages as they become necessary.<\/p>\n<ul>\n<li><a href=\"\/pt\/classic-platforms\/onboard-users#upfront-verification\">Upfront verification<\/a> unlocks all payment processing and payouts, which means you only need to generate the HOP URL once to collect the necessary data.<\/li>\n<li><a href=\"\/pt\/classic-platforms\/onboard-users#staggered-verification\">Staggered verification<\/a> requires you generate a new onboarding URL to collect additional information from the account holder whenever the funds processed exceed their current processing tier.<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n<h2 id=\"create-account-holder\">Step 1: Create an account holder<\/h2>\n<p>Before you start the verification process, you must <a href=\"\/pt\/classic-platforms\/account-holders-and-accounts#create-an-account-holder\">create an account holder<\/a>, taking note of the <code>accountHolderCode<\/code> in the response.<\/p>\n<p>After an account holder is created, they can immediately start processing payments.<\/p>\n<h2 id=\"get-hosted-onboarding-page-url\">Step 2: Get the HOP URL<\/h2>\n<p>When the account holder selects the link or button, make a POST  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Hop\/latest\/post\/getOnboardingUrl\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/getOnboardingUrl<\/a> request.<\/p>\n<p>In your request, you can also include optional parameters such as the URL where the account holder will be redirected back to ( <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Hop\/latest\/post\/getOnboardingUrl#request-returnUrl\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">returnUrl<\/a>), the <a href=\"\/pt\/classic-platforms\/onboard-users\/hosted-onboarding-page\/customize-experience#change-page-language\">language<\/a> the page is rendered in ( <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Hop\/latest\/post\/getOnboardingUrl#request-shopperLocale\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">shopperLocale<\/a>), and the name of the platform shown in the welcome page ( <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Hop\/latest\/post\/getOnboardingUrl#request-platformName\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">platformName<\/a>).<\/p>\n<p>Here's an example of how you generate a HOP URL for an account holder with <code>accountHolderCode<\/code> <span translate=\"no\"><strong>AH0121-TimGreen<\/strong><\/span> with the page rendered in Dutch:<\/p>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Generate a HOP URL'\" :id=\"'getonboardingurl-request'\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/cal-test.adyen.com\\\/cal\\\/services\\\/Hop\\\/v6\\\/getOnboardingUrl \\\\\\n-H 'x-api-key: ADYEN_API_KEY' \\\\\\n-H 'content-type: application\\\/json' \\\\\\n-d '{\\n   \\&quot;{hint:The unique account holder code}accountHolderCode{\\\/hint}\\&quot;: \\&quot;AH0121-TimGreen\\&quot;,\\n   \\&quot;returnUrl\\&quot;: \\&quot;https:\\\/\\\/your.return-url.com\\\/?submerchant=123\\&quot;,\\n   \\&quot;platformName\\&quot; : \\&quot;MyShop.com\\&quot;,\\n   \\&quot;shopperLocale\\&quot;: \\&quot;nl-NL\\&quot;\\n}'&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<p>The response contains:<\/p>\n<ul>\n<li><code>redirectURL<\/code>: The page to where you should redirect your account holder. This URL must be used within 15 seconds and can only be used once.<\/li>\n<li><code>pspReference<\/code>: The reference for this transaction. We recommend that you store this for troubleshooting purposes.<\/li>\n<\/ul>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'\/getOnboardingUrl response'\" :id=\"''\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"{\\n  \\\"invalidFields\\\": [],\\n  \\\"pspReference\\\": \\\"9115677600500127\\\",\\n  \\\"resultCode\\\": \\\"Success\\\",\\n  \\\"redirectUrl\\\": \\\"https:\\\/\\\/hop-test.adyen.com\\\/hop\\\/view\\\/?token=&lt;token&gt;\\\"\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<h2 id=\"handle-redirect\">Step 3: Handle the redirect<\/h2>\n<ol>\n<li>\n<p>Redirect the account holder to the <code>redirectURL<\/code> within 15 seconds after you received the response. When they are successfully redirected to a hosted onboarding page, the session starts. The session is valid for 30 minutes.<\/p>\n<p>The account holder receives an <span translate=\"no\"><strong>HTTP 401<\/strong><\/span> status code if:<\/p>\n<ul>\n<li>The redirection did not occur within 15 seconds.<\/li>\n<li>The account holder refreshes or reloads the browser after the session has started.<\/li>\n<\/ul>\n<p>To resume the session, repeat <a href=\"#get-hosted-onboarding-page-url\">Step 2<\/a> to get a new URL.<\/p>\n<\/li>\n<li>\n<p>Keep track of your account holder's onboarding progress based on the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Notification\/latest\/post\/ACCOUNT_HOLDER_UPDATED\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">ACCOUNT_HOLDER_UPDATED<\/a> notification webhooks you receive.<\/p>\n<\/li>\n<li>\n<p>When the account holder is redirected back to your return URL, inform them of their onboarding progress based on the notification webhooks you received. For example, if the account holder's session expired or they did not finish the onboarding process, repeat <a href=\"#get-hosted-onboarding-page-url\">Step 2<\/a> to get a new URL and to resume the process. The information they provide is saved per section, so the next session continues from the remaining, unsaved sections.<\/p>\n<\/li>\n<\/ol>\n<h2 id=\"get-the-kyc-results\">Step 4: Get the verification results<\/h2>\n<p>You receive all the subsequent verification results in  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Notification\/latest\/post\/ACCOUNT_HOLDER_VERIFICATION\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">ACCOUNT_HOLDER_VERIFICATION<\/a> notification webhooks.<\/p>\n<p>For more information, refer to <a href=\"\/pt\/classic-platforms\/verification-process\/check-verification-results\">verification results<\/a>.<\/p>\n<h2 id=\"access-hop-from-customer-area\">Access HOP on behalf of an account holder<\/h2>\n<p>After you generate a HOP link for an account holder, you can also access their HOP link. This is useful, for example, if an account holder is having issues updating their data or uploading documents.<\/p>\n<p>To be able to view and access the HOP link, you must have the <strong>Manage HOP settings<\/strong> role enabled for your Customer Area user. If you do not have the role, contact your Admin user.<\/p>\n<ol>\n<li>Log in to your <a href=\"https:\/\/ca-live.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>.<\/li>\n<li>Go to <strong>Platform<\/strong> &gt; <strong>Sub-merchants<\/strong> then select the account holder.<\/li>\n<li>In the account holder view, you can select the <strong>Hosted onboarding<\/strong> link shown next to the account holder code.<\/li>\n<\/ol>\n<h2 id=\"see-also\">See also<\/h2>\n<div class=\"see-also-links output-inline\" id=\"see-also\">\n<ul><li><a href=\"\/classic-platforms\/configure-notifications\"\n                        target=\"_self\"\n                        >\n                    Configure notifications\n                <\/a><\/li><li><a href=\"\/classic-platforms\/verification-process\"\n                        target=\"_self\"\n                        >\n                    Verification process\n                <\/a><\/li><\/ul><\/div>\n","url":"https:\/\/docs.adyen.com\/pt\/classic-platforms\/onboard-users\/hosted-onboarding-page","articleFields":{"description":"Simplify your implementation with an Adyen-hosted onboarding page.","search_category":"Classic Platforms","feedback_component":true,"last_edit_on":"29-11-2021 09:13","parameters":{"directoryPath":"\/classic-platforms"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/classic-platforms\/onboard-users\/hosted-onboarding-page","title":"Hosted Onboarding Page","content":"\nThis page is for classic Adyen for Platforms integrations. If you are just starting your implementation, refer to our new integration guide instead.\n\nSend account holders to Adyen's Hosted Onboarding Page (HOP) where they provide additional information directly to Adyen. This is our recommended solution, because it requires less implementation effort on your side.\nWith HOP, you can:\n\nCollect more information. For example, if the verification fails, account holders can use HOP to provide the new information required from them.\nRender the page in your account holder's preferred language.\nCustomize the page's appearance in your Customer Area.\nCustomize the hosted onboarding user experience through the  \/getOnboardingUrl endpoint.\nReceive account updates and verification results through notification webhooks.\n\nHow it works\n\n\n\nCreate an account holder and present a link or a button to start the verification process.\n\n\nWhen the account holder selects the link or the button, provide Adyen with the account holder code and get a one-time HOP URL.\n\n\nHandle the redirect. After the account holder is successfully redirected to the page, the session starts. The session is valid for 30 minutes. When the account holder provides their information, we send account updates through notification webhooks.\nThe account holder is redirected back to your website after they finish providing their details or when the session expires.\n\n\nReceive the verification results through notification webhooks.\n\n\nPlay the video to see a sample HOP session.\n\n\nYour browser does not support the video tag.\n\n\n\nRequirements\n\n\nContact our Support Team to:\n\nEnable hosted onboarding for your platform.\nProvide a default return URL. The default return URL takes the account holder back to your website.\n\n\n\nDecide whether to collect all required information once in the beginning, or later in stages as they become necessary.\n\nUpfront verification unlocks all payment processing and payouts, which means you only need to generate the HOP URL once to collect the necessary data.\nStaggered verification requires you generate a new onboarding URL to collect additional information from the account holder whenever the funds processed exceed their current processing tier.\n\n\n\nStep 1: Create an account holder\nBefore you start the verification process, you must create an account holder, taking note of the accountHolderCode in the response.\nAfter an account holder is created, they can immediately start processing payments.\nStep 2: Get the HOP URL\nWhen the account holder selects the link or button, make a POST  \/getOnboardingUrl request.\nIn your request, you can also include optional parameters such as the URL where the account holder will be redirected back to ( returnUrl), the language the page is rendered in ( shopperLocale), and the name of the platform shown in the welcome page ( platformName).\nHere's an example of how you generate a HOP URL for an account holder with accountHolderCode AH0121-TimGreen with the page rendered in Dutch:\n\n    \n\nThe response contains:\n\nredirectURL: The page to where you should redirect your account holder. This URL must be used within 15 seconds and can only be used once.\npspReference: The reference for this transaction. We recommend that you store this for troubleshooting purposes.\n\n\n    \n\nStep 3: Handle the redirect\n\n\nRedirect the account holder to the redirectURL within 15 seconds after you received the response. When they are successfully redirected to a hosted onboarding page, the session starts. The session is valid for 30 minutes.\nThe account holder receives an HTTP 401 status code if:\n\nThe redirection did not occur within 15 seconds.\nThe account holder refreshes or reloads the browser after the session has started.\n\nTo resume the session, repeat Step 2 to get a new URL.\n\n\nKeep track of your account holder's onboarding progress based on the  ACCOUNT_HOLDER_UPDATED notification webhooks you receive.\n\n\nWhen the account holder is redirected back to your return URL, inform them of their onboarding progress based on the notification webhooks you received. For example, if the account holder's session expired or they did not finish the onboarding process, repeat Step 2 to get a new URL and to resume the process. The information they provide is saved per section, so the next session continues from the remaining, unsaved sections.\n\n\nStep 4: Get the verification results\nYou receive all the subsequent verification results in  ACCOUNT_HOLDER_VERIFICATION notification webhooks.\nFor more information, refer to verification results.\nAccess HOP on behalf of an account holder\nAfter you generate a HOP link for an account holder, you can also access their HOP link. This is useful, for example, if an account holder is having issues updating their data or uploading documents.\nTo be able to view and access the HOP link, you must have the Manage HOP settings role enabled for your Customer Area user. If you do not have the role, contact your Admin user.\n\nLog in to your Customer Area.\nGo to Platform &gt; Sub-merchants then select the account holder.\nIn the account holder view, you can select the Hosted onboarding link shown next to the account holder code.\n\nSee also\n\n\n                    Configure notifications\n                \n                    Verification process\n                \n","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Classic integration","lvl2":"Onboard and verify users","lvl3":"Hosted Onboarding Page"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/classic-platforms","lvl2":"https:\/\/docs.adyen.com\/pt\/classic-platforms\/onboard-users","lvl3":"\/pt\/classic-platforms\/onboard-users\/hosted-onboarding-page"},"levels":4,"category":"Classic Platforms","category_color":"green","tags":["Hosted","Onboarding"]}}