{"title":"Customize the hosted onboarding experience","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>You can easily customize the hosted onboarding user experience 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. The request parameters allow you to:<\/p>\n<ul>\n<li>Offer a modular experience by:\n<ul>\n<li><a href=\"#collect-specific-information\">Collecting only specific data points.<\/a><\/li>\n<li><a href=\"#specify-summary-pages\">Controlling which pages are presented on HOP.<\/a><\/li>\n<\/ul><\/li>\n<li><a href=\"#change-page-language\">Set the default language logic.<\/a><\/li>\n<li><a href=\"#change-edit-settings\">Make it possible for users to update their information, even after check have passed.<\/a><\/li>\n<li><a href=\"#customize-platform-name\">Choose which name to display on the welcome page.<\/a><\/li>\n<li><a href=\"#override-default-url\">Override the default return URL.<\/a><\/li>\n<\/ul>\n<h2 id=\"collect-specific-information\">Collect information only for specific verification checks<\/h2>\n<p>The Hosted Onboarding Page collects information for all verification checks that apply to the <a href=\"\/pt\/classic-platforms\/account-holders-and-accounts#legal-entity-types\">legal entity type<\/a>.<\/p>\n<p>To collect information only for specific <a href=\"\/pt\/classic-platforms\/verification-process\">verification checks<\/a>, specify the <code>collectInformation<\/code> object in your  <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>You can choose to collect information only on the following checks or a combination thereof:<\/p>\n<ul>\n<li>Bank details<\/li>\n<li>Business details<\/li>\n<li>Individual details<\/li>\n<li>PCI questionnaire<\/li>\n<li>Shareholder details<\/li>\n<\/ul>\n<h2 id=\"specify-summary-pages\">Specify which summary pages to show to the account holder<\/h2>\n<p>You can decide whether to show specific pages to the account holder by sending <code>showPages<\/code> object in your  <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>You can show or hide the following pages:<\/p>\n<ul>\n<li>Welcome page<\/li>\n<li>Bank details summary<\/li>\n<li>Business details summary<\/li>\n<li>Individual details summary<\/li>\n<li>Shareholder details summary<\/li>\n<\/ul>\n<p>The welcome page is not shown by default.<\/p>\n<h2 id=\"change-page-language\">Change the page language<\/h2>\n<p>By default, an onboarding page is rendered in the language set in the browser settings. If the browser language is not supported, the page is rendered in <span translate=\"no\"><strong>en-US<\/strong><\/span>.<\/p>\n<p>To change the language:<\/p>\n<ul>\n<li>The account holder can select the language from the drop-down menu at the top or the bottom of the page, depending on the header configuration.<\/li>\n<li>Alternatively, you can send the <code>shopperLocale<\/code> in your  <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. When the account holder opens the page, the page is automatically rendered in the language you specified.<\/li>\n<\/ul>\n<p>If the <code>shopperLocale<\/code> you specified is not supported, the page is rendered in the language set in the browser settings.<\/p>\n<p>The following are the supported values for <code>shopperLocale<\/code>:<\/p>\n<div class=\"sticky-table-container\">\n    \n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Language<\/th>\n<th style=\"text-align: left;\"><code>shopperlocale<\/code><\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\">Croatian<\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>hr-HR<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">Czech<\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>cs-CZ<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">Danish<\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>da-DK<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">Dutch<\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>nl-NL<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">English - US (default)<\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>en-US<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">Finnish<\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>fi-FI<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">French<\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>fr-FR<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">German<\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>de-DE<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">Hungarian<\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>hu-HU<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">Italian<\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>it-IT<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">Norwegian<\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>no-NO<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">Polish<\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>pl-PL<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">Portuguese<\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>pt-BR<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">Romanian<\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>ro-RO<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">Slovakia<\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>sk-SK<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">Slovenian<\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>sl-SI<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">Spanish<\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>es-ES<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">Swedish<\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>sv-SE<\/strong><\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n<\/div>\n\n<h2 id=\"change-edit-settings\">Change editing settings<\/h2>\n<p>The main purpose of HOP is to be a one-time onboarding tool, which means that, by default, account holders cannot edit data on HOP that has already been verified.<br \/>\nHowever, there may be special circumstances that require information to be updated even after verification checks have passed.<br \/>\nTo change the default behavior and allow editing data, send the <code>editMode<\/code> parameter in your  <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<h2 id=\"customize-platform-name\">Customize platform name<\/h2>\n<p>The name of your platform is shown on the welcome page.<br \/>\nTo change the name, you must send the <code>platformName<\/code> in your  <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<h2 id=\"override-default-url\">Override the default return URL<\/h2>\n<p>After the account holders complete the onboarding or their session times out, they are redirected back to the default return URL configured in your platform account.<\/p>\n<p>To change this URL, send the <code>returnURL<\/code> object in your  <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.<br \/>\nThe maximum length of the URL is 500 characters.<\/p>","url":"https:\/\/docs.adyen.com\/pt\/classic-platforms\/onboard-users\/hosted-onboarding-page\/customize-experience","articleFields":{"description":"Customize the users' experience on the Hosted Onboarding Page.","search_category":"Classic Platforms","feedback_component":true,"last_edit_on":"07-03-2022 15:43","parameters":{"integrationPath":"\/classic-platforms"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/classic-platforms\/onboard-users\/hosted-onboarding-page\/customize-experience","title":"Customize the hosted onboarding experience","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\nYou can easily customize the hosted onboarding user experience through the  \/getOnboardingUrl endpoint. The request parameters allow you to:\n\nOffer a modular experience by:\n\nCollecting only specific data points.\nControlling which pages are presented on HOP.\n\nSet the default language logic.\nMake it possible for users to update their information, even after check have passed.\nChoose which name to display on the welcome page.\nOverride the default return URL.\n\nCollect information only for specific verification checks\nThe Hosted Onboarding Page collects information for all verification checks that apply to the legal entity type.\nTo collect information only for specific verification checks, specify the collectInformation object in your  \/getOnboardingUrl request.\nYou can choose to collect information only on the following checks or a combination thereof:\n\nBank details\nBusiness details\nIndividual details\nPCI questionnaire\nShareholder details\n\nSpecify which summary pages to show to the account holder\nYou can decide whether to show specific pages to the account holder by sending showPages object in your  \/getOnboardingUrl request.\nYou can show or hide the following pages:\n\nWelcome page\nBank details summary\nBusiness details summary\nIndividual details summary\nShareholder details summary\n\nThe welcome page is not shown by default.\nChange the page language\nBy default, an onboarding page is rendered in the language set in the browser settings. If the browser language is not supported, the page is rendered in en-US.\nTo change the language:\n\nThe account holder can select the language from the drop-down menu at the top or the bottom of the page, depending on the header configuration.\nAlternatively, you can send the shopperLocale in your  \/getOnboardingUrl request. When the account holder opens the page, the page is automatically rendered in the language you specified.\n\nIf the shopperLocale you specified is not supported, the page is rendered in the language set in the browser settings.\nThe following are the supported values for shopperLocale:\n\n    \n\n\n\nLanguage\nshopperlocale\n\n\n\n\nCroatian\nhr-HR\n\n\nCzech\ncs-CZ\n\n\nDanish\nda-DK\n\n\nDutch\nnl-NL\n\n\nEnglish - US (default)\nen-US\n\n\nFinnish\nfi-FI\n\n\nFrench\nfr-FR\n\n\nGerman\nde-DE\n\n\nHungarian\nhu-HU\n\n\nItalian\nit-IT\n\n\nNorwegian\nno-NO\n\n\nPolish\npl-PL\n\n\nPortuguese\npt-BR\n\n\nRomanian\nro-RO\n\n\nSlovakia\nsk-SK\n\n\nSlovenian\nsl-SI\n\n\nSpanish\nes-ES\n\n\nSwedish\nsv-SE\n\n\n\n\n\n\nChange editing settings\nThe main purpose of HOP is to be a one-time onboarding tool, which means that, by default, account holders cannot edit data on HOP that has already been verified.\nHowever, there may be special circumstances that require information to be updated even after verification checks have passed.\nTo change the default behavior and allow editing data, send the editMode parameter in your  \/getOnboardingUrl request.\nCustomize platform name\nThe name of your platform is shown on the welcome page.\nTo change the name, you must send the platformName in your  \/getOnboardingUrl request.\nOverride the default return URL\nAfter the account holders complete the onboarding or their session times out, they are redirected back to the default return URL configured in your platform account.\nTo change this URL, send the returnURL object in your  \/getOnboardingUrl request.\nThe maximum length of the URL is 500 characters.","type":"page","locale":"pt","boost":16,"hierarchy":{"lvl0":"Home","lvl1":"Classic integration","lvl2":"Onboard and verify users","lvl3":"Hosted Onboarding Page","lvl4":"Customize the hosted onboarding experience"},"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":"https:\/\/docs.adyen.com\/pt\/classic-platforms\/onboard-users\/hosted-onboarding-page","lvl4":"\/pt\/classic-platforms\/onboard-users\/hosted-onboarding-page\/customize-experience"},"levels":5,"category":"Classic Platforms","category_color":"green","tags":["Customize","hosted","onboarding","experience"]}}