{"title":"Customize and test hosted onboarding","category":"default","creationDate":1672313820,"content":"<p>We explain on this page how you can customize your <a href=\"\/pt\/marketplaces\/onboard-users#hosted-onboarding\">hosted onboarding<\/a> page for your users. You can:<\/p>\n<ul>\n<li><a href=\"#create-themes\">Create a hosted onboarding theme<\/a><\/li>\n<li><a href=\"#page-language\">Change the language of the hosted onboarding page<\/a><\/li>\n<li><a href=\"#page-settings\">Change the user settings for the page<\/a><\/li>\n<li><a href=\"#view-themes\">View your hosted onboarding themes<\/a><\/li>\n<li><a href=\"#update-theme\">Update a theme<\/a><\/li>\n<li><a href=\"#test\">Test instant bank verification<\/a><\/li>\n<li><a href=\"#troubleshoot\">Troubleshoot onboarding issues<\/a><\/li>\n<\/ul>\n<h2>Requirements<\/h2>\n<p>Take into account the following requirements, limitations, and preparations<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Requirement<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><strong>Integration type<\/strong><\/td>\n<td style=\"text-align: left;\">You have an <a href=\"\/pt\/adyen-for-platforms-model\/\">Adyen for Platforms<\/a> or <a href=\"\/pt\/issuing\">Adyen Issuing<\/a> integration.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong><a href=\"\/pt\/development-resources\/api-credentials\/\">API credentials<\/a><\/strong><\/td>\n<td style=\"text-align: left;\">If you are using <a href=\"\/pt\/marketplaces\/\/onboard-users?tab=api-initiated_1_2\">API-initiated hosted onboarding<\/a>, you must have credentials for the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/legalentity\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Legal Entity Management API<\/a>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong><a href=\"\/pt\/account\/user-roles\">Customer Area roles<\/a><\/strong><\/td>\n<td style=\"text-align: left;\">To create or edit hosted onboarding themes, you must have the following roles:<\/br>- <strong>Manage hosted onboarding themes<\/strong><\/br>- <strong>Balance platform admin role<\/strong> or <strong>Balance platform base role<\/strong><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2 id=\"create-themes\">Create a hosted onboarding theme<\/h2>\n<p>You can customize the appearance of your hosted onboarding page by creating a theme. For the best user experience, we recommend the following when you create your theme:<\/p>\n<ul>\n<li>Incorporate your logo to highlight your brand identity.<\/li>\n<li>Use a clear and meaningful page header.<\/li>\n<li>Include a descriptive tab title and a favicon to make the page tab visible in the browser.<\/li>\n<li>Add a  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/legalentity\/latest\/post\/legalEntities\/(id)\/onboardingLinks#request-redirectUrl\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">redirectUrl<\/a> that takes the user back to your platform after completing the hosted onboarding.<\/li>\n<li>When choosing color combinations, ensure they complement each other well and provide enough contrast for readability, especially for text and navigation elements. Consider accessibility guidelines to ensure the color palette is inclusive and usable for individuals with visual impairments.<\/li>\n<\/ul>\n<p>To add a new theme:<\/p>\n<ol>\n<li>\n<p>Log in to your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>.<\/p>\n<\/li>\n<li>\n<p>Select the company account.<\/p>\n<\/li>\n<li>\n<p>Select <strong>Settings<\/strong> &gt; <strong>Hosted onboarding<\/strong>.<\/p>\n<\/li>\n<li>\n<p>Select <strong>Add new<\/strong> from the drop-down menu.<\/p>\n<\/li>\n<li>\n<p>Add an optional description to identify the theme. If you do not add a description, the theme ID is shown in the drop-down menu list.<\/p>\n<\/li>\n<li>\n<p>Customize the browser tab:<\/p>\n<ol>\n<li>Add a tab title of up to 60 characters.<\/li>\n<li>Upload a favicon of a 1:1 ratio.<\/li>\n<\/ol>\n<\/li>\n<li>\n<p>Customize the appearance of your page:<\/p>\n<ol>\n<li>Upload your brand logo. The file size limit for a logo is 5 MB in JPG format.<\/li>\n<li>Specify your page header.<\/li>\n<li>Select a background for your page. You can choose either:\n<ul>\n<li>A background color using a hex color code.<\/li>\n<li>A background image. The file size limit for an image is 5 MB in PDF or JPG format.<\/li>\n<\/ul><\/li>\n<\/ol>\n<\/li>\n<li>\n<p>Add the external links to appear on your hosted onboarding page. We recommend you use the following:<\/p>\n<table>\n<thead>\n<tr>\n<th>Page name<\/th>\n<th>URL<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>Support<\/td>\n<td>Your own support page<\/td>\n<\/tr>\n<tr>\n<td>Privacy statement<\/td>\n<td><a href=\"https:\/\/www.adyen.com\/policies-and-disclaimer\/privacy-policy\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Adyen privacy policy<\/a><\/td>\n<\/tr>\n<tr>\n<td>F.A.Q.<\/td>\n<td><a href=\"\/pt\/hosted-onboarding-faqs\">Hosted onboarding FAQs<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<li>\n<p>Select <strong>Save<\/strong> to confirm the theme configurations.<\/p>\n<\/li>\n<li>\n<p>Copy a unique <a href=\"https:\/\/docs.adyen.com\/api-explorer\/legalentity\/latest\/get\/themes\/_id_#path-id\" class=\"codeLabel external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">ID<\/a> of your theme. You need to pass this ID when making a POST  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/legalentity\/latest\/post\/legalEntities\/(id)\/onboardingLinks\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/legalEntities\/{id}\/onboardingLinks<\/a> request to create a hosted onboarding link.<\/p>\n<\/li>\n<\/ol>\n<p>To get an idea of how your hosted onboarding page could look, refer to the examples below.<\/p>\n\n<div id=\"taboIENh\">\n    <div data-component-wrapper=\"tabs\">\n        <tabs\n                        :items=\"[{&quot;title&quot;:&quot;Custom page header&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;&lt;a rel=\\&quot;lightbox\\&quot; href=\\&quot;\\\/user\\\/pages\\\/reuse\\\/pfs-onboarding\\\/hosted-onboarding\\\/customize-ho\\\/custom-header.png\\&quot; src=\\&quot;\\&quot;&gt;\\n  &lt;img alt=\\&quot;\\&quot; src=\\&quot;\\\/user\\\/pages\\\/reuse\\\/pfs-onboarding\\\/hosted-onboarding\\\/customize-ho\\\/custom-header.png\\&quot; \\\/&gt;\\n&lt;\\\/a&gt;&lt;\\\/p&gt;\\n&quot;,&quot;altTitle&quot;:&quot;custom-header&quot;,&quot;oldTabId&quot;:&quot;custom-header_1&quot;,&quot;relation&quot;:&quot;&quot;},{&quot;title&quot;:&quot;Custom background image&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;&lt;a rel=\\&quot;lightbox\\&quot; href=\\&quot;\\\/user\\\/pages\\\/reuse\\\/pfs-onboarding\\\/hosted-onboarding\\\/customize-ho\\\/custom-background.png\\&quot; src=\\&quot;\\&quot;&gt;\\n  &lt;img alt=\\&quot;\\&quot; src=\\&quot;\\\/user\\\/pages\\\/reuse\\\/pfs-onboarding\\\/hosted-onboarding\\\/customize-ho\\\/custom-background.png\\&quot; \\\/&gt;\\n&lt;\\\/a&gt;&lt;\\\/p&gt;\\n&quot;,&quot;altTitle&quot;:&quot;custom-background&quot;,&quot;oldTabId&quot;:&quot;custom-background_2&quot;,&quot;relation&quot;:&quot;&quot;}]\"\n            :should-update-when-url-changes='true'>\n        <\/tabs>\n    <\/div>\n<\/div>\n\n<h2 id=\"page-language\">Change the page language<\/h2>\n<p>By default, the hosted onboarding page is rendered in the language set in the browser settings. If the browser language is not supported, the page is rendered in <strong>en-US<\/strong>. You can change the language of the page by specifying the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/legalentity\/latest\/post\/legalEntities\/(id)\/onboardingLinks#request-locale\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">locale<\/a> in your  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/legalentity\/latest\/post\/legalEntities\/(id)\/onboardingLinks\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/legalEntities\/{id}\/onboardingLinks<\/a> request.<\/p>\n<p>The values for  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/legalentity\/latest\/post\/legalEntities\/(id)\/onboardingLinks#request-locale\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">locale<\/a> are a combination of the two letter <a href=\"https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">ISO 639-1<\/a> language and <a href=\"https:\/\/en.wikipedia.org\/wiki\/ISO_3166-1_alpha-2\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">ISO 3166-1 alpha-2<\/a> country codes. If an unsupported  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/legalentity\/latest\/post\/legalEntities\/(id)\/onboardingLinks#request-locale\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">locale<\/a> value is sent in the request, the page is rendered in the next available value for a given language. For example, if <strong>en-GB<\/strong> is sent, the page defaults to <strong>en-US<\/strong>.<\/p>\n<p>The following languages are currently supported.<\/p>\n<table>\n<thead>\n<tr>\n<th>Language<\/th>\n<th>Locale<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>Bulgarian<\/td>\n<td><strong>bg-BG<\/strong><\/td>\n<\/tr>\n<tr>\n<td>Croatian<\/td>\n<td><strong>hr-HR<\/strong><\/td>\n<\/tr>\n<tr>\n<td>Czech<\/td>\n<td><strong>cs-CZ<\/strong><\/td>\n<\/tr>\n<tr>\n<td>Danish<\/td>\n<td><strong>da-DK<\/strong><\/td>\n<\/tr>\n<tr>\n<td>Dutch<\/td>\n<td><strong>nl-NL<\/strong><\/td>\n<\/tr>\n<tr>\n<td>English<\/td>\n<td><strong>en-US<\/strong><\/td>\n<\/tr>\n<tr>\n<td>Estonian<\/td>\n<td><strong>et-EE<\/strong><\/td>\n<\/tr>\n<tr>\n<td>Finnish<\/td>\n<td><strong>fi-FI<\/strong><\/td>\n<\/tr>\n<tr>\n<td>French<\/td>\n<td><strong>fr-FR<\/strong><\/td>\n<\/tr>\n<tr>\n<td>German<\/td>\n<td><strong>de-DE<\/strong><\/td>\n<\/tr>\n<tr>\n<td>Greek<\/td>\n<td><strong>el-GR<\/strong><\/td>\n<\/tr>\n<tr>\n<td>Hungarian<\/td>\n<td><strong>hu-HU<\/strong><\/td>\n<\/tr>\n<tr>\n<td>Italian<\/td>\n<td><strong>it-IT<\/strong><\/td>\n<\/tr>\n<tr>\n<td>Latvian<\/td>\n<td><strong>lv-LV<\/strong><\/td>\n<\/tr>\n<tr>\n<td>Lithuanian<\/td>\n<td><strong>lt-LT<\/strong><\/td>\n<\/tr>\n<tr>\n<td>Norwegian<\/td>\n<td><strong>no-NO<\/strong><\/td>\n<\/tr>\n<tr>\n<td>Polish<\/td>\n<td><strong>pl-PL<\/strong><\/td>\n<\/tr>\n<tr>\n<td>Portuguese<\/td>\n<td><strong>pt-PT<\/strong><\/td>\n<\/tr>\n<tr>\n<td>Romanian<\/td>\n<td><strong>ro-RO<\/strong><\/td>\n<\/tr>\n<tr>\n<td>Slovak<\/td>\n<td><strong>sk-SK<\/strong><\/td>\n<\/tr>\n<tr>\n<td>Slovenian<\/td>\n<td><strong>sl-SI<\/strong><\/td>\n<\/tr>\n<tr>\n<td>Spanish<\/td>\n<td><strong>es-ES<\/strong><\/td>\n<\/tr>\n<tr>\n<td>Swedish<\/td>\n<td><strong>sv-SE<\/strong><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2 id=\"page-settings\">Change page settings<\/h2>\n<p>You can control particular actions that your user performs in the hosted onboarding page by specifying the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/legalentity\/latest\/post\/legalEntities\/(id)\/onboardingLinks#request-settings\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">settings<\/a> in your  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/legalentity\/latest\/post\/legalEntities\/(id)\/onboardingLinks\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/legalEntities\/{id}\/onboardingLinks<\/a> request.<\/p>\n<p>The  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/legalentity\/latest\/post\/legalEntities\/(id)\/onboardingLinks#request-settings\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">settings<\/a> object contains key-value pairs, where the key represents a specific setting.<\/p>\n<div class=\"sticky-table-container\">\n    \n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Setting<\/th>\n<th style=\"text-align: center;\">Type<\/th>\n<th style=\"text-align: center;\">Default value<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><code>acceptedCountries<\/code><\/td>\n<td style=\"text-align: center;\">array of strings<\/td>\n<td style=\"text-align: center;\"><\/td>\n<td style=\"text-align: left;\">The list of countries the user can choose from in hosted onboarding when <code>editPrefilledCountry<\/code> is allowed.<\/br><\/br>The value must be in the two-character <a href=\"https:\/\/en.wikipedia.org\/wiki\/ISO_3166-1_alpha-2\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">ISO 3166-1 alpha-2<\/a> country code format.<\/br><\/br>The array is empty by default, allowing all <a href=\"\/pt\/marketplaces\/onboard-users\/#supported-countries-regions\">countries and regions supported by hosted onboarding<\/a>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>allowBankAccountFormatSelection<\/code><\/td>\n<td style=\"text-align: center;\">boolean<\/td>\n<td style=\"text-align: center;\"><strong>false<\/strong><\/td>\n<td style=\"text-align: left;\">The user can select the <a href=\"\/pt\/marketplaces\/payout-to-users\/#supported-currencies\">format for their payout account<\/a> if applicable.<\/br><\/br>Set this to <strong>true<\/strong> to allow the action.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>allowDebugUi<\/code><\/td>\n<td style=\"text-align: center;\">boolean<\/td>\n<td style=\"text-align: center;\"><strong>true<\/strong><\/td>\n<td style=\"text-align: left;\">The debug user interface (UI) is enabled and can be accessed using a keyboard shortcut.<\/br><\/br>Set this to <strong>false<\/strong> to disable the tool.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>allowIntraRegionCrossBorderPayout<\/code><\/td>\n<td style=\"text-align: center;\">boolean<\/td>\n<td style=\"text-align: center;\"><strong>false<\/strong><\/td>\n<td style=\"text-align: left;\">The user can select a payout account in a different EU\/EEA location (including Switzerland and the UK) than the location of their legal entity.<\/br><\/br>Set this to <strong>true<\/strong> to allow the action.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>changeLegalEntityType<\/code><\/td>\n<td style=\"text-align: center;\">boolean<\/td>\n<td style=\"text-align: center;\"><strong>true<\/strong><\/td>\n<td style=\"text-align: left;\">The user can change their legal entity type.<\/br><\/br>Set this to <strong>false<\/strong> to not allow the action.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>editPrefilledCountry<\/code><\/td>\n<td style=\"text-align: center;\">boolean<\/td>\n<td style=\"text-align: center;\"><strong>true<\/strong><\/td>\n<td style=\"text-align: left;\">The user can change the country of their legal entity's address, for example the registered address of an organization.<\/br><\/br>Set this to <strong>false<\/strong> to not allow the action.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>enforceLegalAge<\/code><\/td>\n<td style=\"text-align: center;\">boolean<\/td>\n<td style=\"text-align: center;\"><strong>false<\/strong><\/td>\n<td style=\"text-align: left;\">The user cannot be onboarded if they are less than 18 years of age.<\/br><\/br>Set this to <strong>true<\/strong> to prevent underage users from being onboarded.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>hideOnboardingIntroductionIndividual<\/code><\/td>\n<td style=\"text-align: center;\">boolean<\/td>\n<td style=\"text-align: center;\"><strong>true<\/strong><\/td>\n<td style=\"text-align: left;\">The introduction screen is hidden for the user of the individual legal entity type.<\/br><\/br>The introduction screen provides brief instructions for the subsequent steps in the hosted onboarding process.<\/br><\/br>Set this to <strong>false<\/strong> to allow the action.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>hideOnboardingIntroductionOrganization<\/code><\/td>\n<td style=\"text-align: center;\">boolean<\/td>\n<td style=\"text-align: center;\"><strong>true<\/strong><\/td>\n<td style=\"text-align: left;\">The introduction screen is hidden for the user of the organization legal entity type.<\/br><\/br>The introduction screen provides brief instructions for the subsequent steps in the hosted onboarding process.<\/br><\/br>Set this to <strong>false<\/strong> to allow the action.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>instantBankVerification<\/code><\/td>\n<td style=\"text-align: center;\">boolean<\/td>\n<td style=\"text-align: center;\"><strong>true<\/strong><\/td>\n<td style=\"text-align: left;\">The user can initiate the verification process through open banking providers, like Plaid or Tink.<\/br><\/br>Set this to <strong>false<\/strong> to not allow the action.<\/td>\n<td><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>transferInstrumentLimit<\/code><\/td>\n<td style=\"text-align: center;\">integer<\/td>\n<td style=\"text-align: center;\"><\/td>\n<td style=\"text-align: left;\">The maximum number of transfer instruments the user can create.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n<\/div>\n\n<h2 id=\"view-themes\">View hosted onboarding themes<\/h2>\n<p>You can view your hosted onboarding themes and assets in your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a> or by making API requests using the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/legalentity\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Legal Entity Management API<\/a>.<\/p>\n\n<div id=\"tabAPUVy\">\n    <div data-component-wrapper=\"tabs\">\n        <tabs\n                        :items=\"[{&quot;title&quot;:&quot;Customer Area&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;To view the themes in your &lt;a href=\\&quot;https:\\\/\\\/ca-test.adyen.com\\\/\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot; class=\\&quot;external-link no-image\\&quot;&gt;Customer Area&lt;\\\/a&gt;:&lt;\\\/p&gt;\\n&lt;ol&gt;\\n&lt;li&gt;Go to &lt;strong&gt;Settings&lt;\\\/strong&gt; &amp;gt; &lt;strong&gt;Hosted onboarding&lt;\\\/strong&gt;.&lt;\\\/li&gt;\\n&lt;li&gt;Select a theme from the dropdown menu.&lt;\\\/li&gt;\\n&lt;\\\/ol&gt;\\n&quot;,&quot;altTitle&quot;:&quot;ho-customer-area&quot;,&quot;oldTabId&quot;:&quot;ho-customer-area_1&quot;,&quot;relation&quot;:&quot;&quot;},{&quot;title&quot;:&quot;API&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;To get themes, use the following endpoints in the  &lt;a href=\\&quot;https:\\\/\\\/docs.adyen.com\\\/api-explorer\\\/legalentity\\\/latest\\\/overview\\&quot; class=\\&quot; external-link no-image\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot;&gt;Legal Entity Management API&lt;\\\/a&gt;&amp;#58;&lt;\\\/p&gt;\\n&lt;ul&gt;\\n&lt;li&gt;GET  &lt;a href=\\&quot;https:\\\/\\\/docs.adyen.com\\\/api-explorer\\\/legalentity\\\/latest\\\/get\\\/themes\\&quot; class=\\&quot;codeLabel  external-link no-image\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot;&gt;\\\/themes&lt;\\\/a&gt;&amp;#58; view a list of hosted onboarding themes.&lt;\\\/li&gt;\\n&lt;li&gt;GET  &lt;a href=\\&quot;https:\\\/\\\/docs.adyen.com\\\/api-explorer\\\/legalentity\\\/latest\\\/get\\\/themes\\\/(id)\\&quot; class=\\&quot;codeLabel  external-link no-image\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot;&gt;\\\/themes\\\/id&lt;\\\/a&gt;`: view a specific theme.&lt;\\\/li&gt;\\n&lt;\\\/ul&gt;\\n&quot;,&quot;altTitle&quot;:&quot;ho-theme&quot;,&quot;oldTabId&quot;:&quot;ho-theme_2&quot;,&quot;relation&quot;:&quot;&quot;}]\"\n            :should-update-when-url-changes='true'>\n        <\/tabs>\n    <\/div>\n<\/div>\n\n<h2 id=\"update-theme\">Update a hosted onboarding theme<\/h2>\n<p>To update a theme in your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>:<\/p>\n<ol>\n<li>Go to <strong>Settings<\/strong> &gt; <strong>Hosted onboarding<\/strong>.<\/li>\n<li>Select a theme from the dropdown menu.<\/li>\n<li>Make your changes and select <strong>Save<\/strong>.<\/li>\n<\/ol>\n<h2 id=\"test\">Test instant bank verification<\/h2>\n<p>To test the instant bank verification flow:<\/p>\n<ol>\n<li>In your test environment, select the test account for your specified country\/region.<\/li>\n<li>Enter the corresponding user name and password from the table below.<\/li>\n<\/ol>\n<table>\n<thead>\n<tr>\n<th>Country\/region<\/th>\n<th style=\"text-align: center;\">Test account<\/th>\n<th style=\"text-align: center;\">User name<\/th>\n<th style=\"text-align: center;\">Password<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>Canada<\/td>\n<td style=\"text-align: center;\">Any institution<\/td>\n<td style=\"text-align: center;\">user_good<\/td>\n<td style=\"text-align: center;\">user_good<\/td>\n<\/tr>\n<tr>\n<td>Belgium<\/td>\n<td style=\"text-align: center;\"><strong>Tink Demo Bank<\/strong><\/td>\n<td style=\"text-align: center;\">u51613239<\/td>\n<td style=\"text-align: center;\">cty440<\/td>\n<\/tr>\n<tr>\n<td>Denmark<\/td>\n<td style=\"text-align: center;\"><strong>Tink Demo Bank<\/strong><\/td>\n<td style=\"text-align: center;\">u51613239<\/td>\n<td style=\"text-align: center;\">cty440<\/td>\n<\/tr>\n<tr>\n<td>Estonia<\/td>\n<td style=\"text-align: center;\"><strong>Tink Demo Bank<\/strong><\/td>\n<td style=\"text-align: center;\">u91902655<\/td>\n<td style=\"text-align: center;\">jtx720<\/td>\n<\/tr>\n<tr>\n<td>Finland<\/td>\n<td style=\"text-align: center;\"><strong>Tink Demo Bank<\/strong><\/td>\n<td style=\"text-align: center;\">u80628915<\/td>\n<td style=\"text-align: center;\">puv375<\/td>\n<\/tr>\n<tr>\n<td>France<\/td>\n<td style=\"text-align: center;\"><strong>Tink Demo Bank<\/strong><\/td>\n<td style=\"text-align: center;\">u98563939<\/td>\n<td style=\"text-align: center;\">ene512<\/td>\n<\/tr>\n<tr>\n<td>Germany<\/td>\n<td style=\"text-align: center;\"><strong>Tink Demo Bank<\/strong><\/td>\n<td style=\"text-align: center;\">u98235448<\/td>\n<td style=\"text-align: center;\">cdz248<\/td>\n<\/tr>\n<tr>\n<td>Italy<\/td>\n<td style=\"text-align: center;\"><strong>Tink Demo Bank<\/strong><\/td>\n<td style=\"text-align: center;\">u51613239<\/td>\n<td style=\"text-align: center;\">cty440<\/td>\n<\/tr>\n<tr>\n<td>Latvia<\/td>\n<td style=\"text-align: center;\"><strong>Tink Demo Bank<\/strong><\/td>\n<td style=\"text-align: center;\">u91902655<\/td>\n<td style=\"text-align: center;\">jtx720<\/td>\n<\/tr>\n<tr>\n<td>Lithuania<\/td>\n<td style=\"text-align: center;\"><strong>Tink Demo Bank<\/strong><\/td>\n<td style=\"text-align: center;\">u91902655<\/td>\n<td style=\"text-align: center;\">jtx720<\/td>\n<\/tr>\n<tr>\n<td>Netherlands<\/td>\n<td style=\"text-align: center;\"><strong>Tink Demo Bank<\/strong><\/td>\n<td style=\"text-align: center;\">u48874162<\/td>\n<td style=\"text-align: center;\">idz429<\/td>\n<\/tr>\n<tr>\n<td>Norway<\/td>\n<td style=\"text-align: center;\"><strong>Tink Demo Bank<\/strong><\/td>\n<td style=\"text-align: center;\">u26049657<\/td>\n<td style=\"text-align: center;\">mip544<\/td>\n<\/tr>\n<tr>\n<td>Poland<\/td>\n<td style=\"text-align: center;\"><strong>Tink Demo Bank<\/strong><\/td>\n<td style=\"text-align: center;\">u51613239<\/td>\n<td style=\"text-align: center;\">cty440<\/td>\n<\/tr>\n<tr>\n<td>Portugal<\/td>\n<td style=\"text-align: center;\"><strong>Tink Demo Bank<\/strong><\/td>\n<td style=\"text-align: center;\">u51613239<\/td>\n<td style=\"text-align: center;\">cty440<\/td>\n<\/tr>\n<tr>\n<td>Spain<\/td>\n<td style=\"text-align: center;\"><strong>Tink Demo Bank<\/strong><\/td>\n<td style=\"text-align: center;\">u82144157<\/td>\n<td style=\"text-align: center;\">ymm529<\/td>\n<\/tr>\n<tr>\n<td>Sweden<\/td>\n<td style=\"text-align: center;\"><strong>Tink Demo Bank<\/strong><\/td>\n<td style=\"text-align: center;\">u27678322<\/td>\n<td style=\"text-align: center;\">vrh343<\/td>\n<\/tr>\n<tr>\n<td>United Kingdom<\/td>\n<td style=\"text-align: center;\"><strong>Tink Demo Bank<\/strong><\/td>\n<td style=\"text-align: center;\">u30315772<\/td>\n<td style=\"text-align: center;\">ndg370<\/td>\n<\/tr>\n<tr>\n<td>United States<\/td>\n<td style=\"text-align: center;\">Any institution<\/td>\n<td style=\"text-align: center;\">user_good<\/td>\n<td style=\"text-align: center;\">user_good<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2 id=\"troubleshoot\">Troubleshoot hosted onboarding<\/h2>\n<p>You may need to troubleshoot if your user encounters issues during the hosted onboarding process. Hosted onboarding provides a browser-based user interface (UI) for you to use to debug. This tool allows you and your team to:<\/p>\n<ul>\n<li>Diagnose and resolve issues faced by your users during their onboarding.<\/li>\n<li>Collect necessary details about these issues for possible escalation to support or engineering teams.<\/li>\n<\/ul>\n<p>The debug UI is enabled by default and is intended for use by your support and engineering teams, not by your marketplace users. You can control the availability of the debug UI by adjusting the <a href=\"#page-settings\">\n  <code>allowDebugUi<\/code>\n<\/a> setting when creating an onboarding link.<\/p>\n<p>To access the debug UI:<\/p>\n<ol>\n<li>Press <code>Ctrl + Shift + \\<\/code> on your keyboard while in the hosted onboarding page. A comprehensive report of debug information will appear.<\/li>\n<li>To share the report, select <strong>Copy debug info<\/strong> at the bottom and include it in your support request.<\/li>\n<\/ol>\n<div class=\"sc-notice note\"><div>\n<p>Note that the debug report contains sensitive information and must be treated cautiously and to the minimum required extent. Only share this information with your team or Adyen Support for troubleshooting purposes.<\/p>\n<\/div><\/div>\n<p>The debug report includes:<\/p>\n<ul>\n<li><strong>Metadata<\/strong>: Information about the SDK version, the user's <a href=\"#page-language\">locale<\/a>, and the ID of the main legal entity.<\/li>\n<li><strong>Experiments and Settings<\/strong>: A list of enabled and disabled features (also known as experiments), along with the <a href=\"#page-settings\">settings<\/a> that were specified when creating an onboarding link.<\/li>\n<li><strong>Task Statuses<\/strong>: Information on onboarding tasks that the user needs to complete, along with their current statuses. You can also see why a task shows a specific status, such as verification errors or missing data.<\/li>\n<li><strong>Legal Entity Data<\/strong>: Information about the main legal entity linked to the account holder. Here, you can review the entire JSON response for the main legal entity, including entity associations and capabilities of the corresponding account holder.<\/li>\n<\/ul>\n<p><img alt=\"\" src=\"\/user\/pages\/reuse\/pfs-onboarding\/hosted-onboarding\/customize-ho\/debug-ui.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/p>","url":"https:\/\/docs.adyen.com\/pt\/marketplaces\/onboard-users\/customize-hosted-onboarding","articleFields":{"description":"Learn how to customize, test, and troubleshoot your hosted onboarding page.","feedback_component":true,"last_edit_on":"27-02-2024 14:04","filters_component":false,"page_id":"58a71d42-857f-412f-9c59-808c6620363d","decision_tree":"[]","parameters":{"directoryPath":"\/marketplaces","model":"marketplace"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/marketplaces\/onboard-users\/customize-hosted-onboarding","title":"Customize and test hosted onboarding","content":"We explain on this page how you can customize your hosted onboarding page for your users. You can:\n\nCreate a hosted onboarding theme\nChange the language of the hosted onboarding page\nChange the user settings for the page\nView your hosted onboarding themes\nUpdate a theme\nTest instant bank verification\nTroubleshoot onboarding issues\n\nRequirements\nTake into account the following requirements, limitations, and preparations\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nYou have an Adyen for Platforms or Adyen Issuing integration.\n\n\nAPI credentials\nIf you are using API-initiated hosted onboarding, you must have credentials for the  Legal Entity Management API.\n\n\nCustomer Area roles\nTo create or edit hosted onboarding themes, you must have the following roles:- Manage hosted onboarding themes- Balance platform admin role or Balance platform base role\n\n\n\nCreate a hosted onboarding theme\nYou can customize the appearance of your hosted onboarding page by creating a theme. For the best user experience, we recommend the following when you create your theme:\n\nIncorporate your logo to highlight your brand identity.\nUse a clear and meaningful page header.\nInclude a descriptive tab title and a favicon to make the page tab visible in the browser.\nAdd a  redirectUrl that takes the user back to your platform after completing the hosted onboarding.\nWhen choosing color combinations, ensure they complement each other well and provide enough contrast for readability, especially for text and navigation elements. Consider accessibility guidelines to ensure the color palette is inclusive and usable for individuals with visual impairments.\n\nTo add a new theme:\n\n\nLog in to your Customer Area.\n\n\nSelect the company account.\n\n\nSelect Settings &gt; Hosted onboarding.\n\n\nSelect Add new from the drop-down menu.\n\n\nAdd an optional description to identify the theme. If you do not add a description, the theme ID is shown in the drop-down menu list.\n\n\nCustomize the browser tab:\n\nAdd a tab title of up to 60 characters.\nUpload a favicon of a 1:1 ratio.\n\n\n\nCustomize the appearance of your page:\n\nUpload your brand logo. The file size limit for a logo is 5 MB in JPG format.\nSpecify your page header.\nSelect a background for your page. You can choose either:\n\nA background color using a hex color code.\nA background image. The file size limit for an image is 5 MB in PDF or JPG format.\n\n\n\n\nAdd the external links to appear on your hosted onboarding page. We recommend you use the following:\n\n\n\nPage name\nURL\n\n\n\n\nSupport\nYour own support page\n\n\nPrivacy statement\nAdyen privacy policy\n\n\nF.A.Q.\nHosted onboarding FAQs\n\n\n\n\n\nSelect Save to confirm the theme configurations.\n\n\nCopy a unique ID of your theme. You need to pass this ID when making a POST  \/legalEntities\/{id}\/onboardingLinks request to create a hosted onboarding link.\n\n\nTo get an idea of how your hosted onboarding page could look, refer to the examples below.\n\n\n    \n        \n        \n    \n\n\nChange the page language\nBy default, the hosted 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. You can change the language of the page by specifying the  locale in your  \/legalEntities\/{id}\/onboardingLinks request.\nThe values for  locale are a combination of the two letter ISO 639-1 language and ISO 3166-1 alpha-2 country codes. If an unsupported  locale value is sent in the request, the page is rendered in the next available value for a given language. For example, if en-GB is sent, the page defaults to en-US.\nThe following languages are currently supported.\n\n\n\nLanguage\nLocale\n\n\n\n\nBulgarian\nbg-BG\n\n\nCroatian\nhr-HR\n\n\nCzech\ncs-CZ\n\n\nDanish\nda-DK\n\n\nDutch\nnl-NL\n\n\nEnglish\nen-US\n\n\nEstonian\net-EE\n\n\nFinnish\nfi-FI\n\n\nFrench\nfr-FR\n\n\nGerman\nde-DE\n\n\nGreek\nel-GR\n\n\nHungarian\nhu-HU\n\n\nItalian\nit-IT\n\n\nLatvian\nlv-LV\n\n\nLithuanian\nlt-LT\n\n\nNorwegian\nno-NO\n\n\nPolish\npl-PL\n\n\nPortuguese\npt-PT\n\n\nRomanian\nro-RO\n\n\nSlovak\nsk-SK\n\n\nSlovenian\nsl-SI\n\n\nSpanish\nes-ES\n\n\nSwedish\nsv-SE\n\n\n\nChange page settings\nYou can control particular actions that your user performs in the hosted onboarding page by specifying the  settings in your  \/legalEntities\/{id}\/onboardingLinks request.\nThe  settings object contains key-value pairs, where the key represents a specific setting.\n\n    \n\n\n\nSetting\nType\nDefault value\nDescription\n\n\n\n\nacceptedCountries\narray of strings\n\nThe list of countries the user can choose from in hosted onboarding when editPrefilledCountry is allowed.The value must be in the two-character ISO 3166-1 alpha-2 country code format.The array is empty by default, allowing all countries and regions supported by hosted onboarding.\n\n\nallowBankAccountFormatSelection\nboolean\nfalse\nThe user can select the format for their payout account if applicable.Set this to true to allow the action.\n\n\nallowDebugUi\nboolean\ntrue\nThe debug user interface (UI) is enabled and can be accessed using a keyboard shortcut.Set this to false to disable the tool.\n\n\nallowIntraRegionCrossBorderPayout\nboolean\nfalse\nThe user can select a payout account in a different EU\/EEA location (including Switzerland and the UK) than the location of their legal entity.Set this to true to allow the action.\n\n\nchangeLegalEntityType\nboolean\ntrue\nThe user can change their legal entity type.Set this to false to not allow the action.\n\n\neditPrefilledCountry\nboolean\ntrue\nThe user can change the country of their legal entity's address, for example the registered address of an organization.Set this to false to not allow the action.\n\n\nenforceLegalAge\nboolean\nfalse\nThe user cannot be onboarded if they are less than 18 years of age.Set this to true to prevent underage users from being onboarded.\n\n\nhideOnboardingIntroductionIndividual\nboolean\ntrue\nThe introduction screen is hidden for the user of the individual legal entity type.The introduction screen provides brief instructions for the subsequent steps in the hosted onboarding process.Set this to false to allow the action.\n\n\nhideOnboardingIntroductionOrganization\nboolean\ntrue\nThe introduction screen is hidden for the user of the organization legal entity type.The introduction screen provides brief instructions for the subsequent steps in the hosted onboarding process.Set this to false to allow the action.\n\n\ninstantBankVerification\nboolean\ntrue\nThe user can initiate the verification process through open banking providers, like Plaid or Tink.Set this to false to not allow the action.\n\n\n\ntransferInstrumentLimit\ninteger\n\nThe maximum number of transfer instruments the user can create.\n\n\n\n\n\n\nView hosted onboarding themes\nYou can view your hosted onboarding themes and assets in your Customer Area or by making API requests using the  Legal Entity Management API.\n\n\n    \n        \n        \n    \n\n\nUpdate a hosted onboarding theme\nTo update a theme in your Customer Area:\n\nGo to Settings &gt; Hosted onboarding.\nSelect a theme from the dropdown menu.\nMake your changes and select Save.\n\nTest instant bank verification\nTo test the instant bank verification flow:\n\nIn your test environment, select the test account for your specified country\/region.\nEnter the corresponding user name and password from the table below.\n\n\n\n\nCountry\/region\nTest account\nUser name\nPassword\n\n\n\n\nCanada\nAny institution\nuser_good\nuser_good\n\n\nBelgium\nTink Demo Bank\nu51613239\ncty440\n\n\nDenmark\nTink Demo Bank\nu51613239\ncty440\n\n\nEstonia\nTink Demo Bank\nu91902655\njtx720\n\n\nFinland\nTink Demo Bank\nu80628915\npuv375\n\n\nFrance\nTink Demo Bank\nu98563939\nene512\n\n\nGermany\nTink Demo Bank\nu98235448\ncdz248\n\n\nItaly\nTink Demo Bank\nu51613239\ncty440\n\n\nLatvia\nTink Demo Bank\nu91902655\njtx720\n\n\nLithuania\nTink Demo Bank\nu91902655\njtx720\n\n\nNetherlands\nTink Demo Bank\nu48874162\nidz429\n\n\nNorway\nTink Demo Bank\nu26049657\nmip544\n\n\nPoland\nTink Demo Bank\nu51613239\ncty440\n\n\nPortugal\nTink Demo Bank\nu51613239\ncty440\n\n\nSpain\nTink Demo Bank\nu82144157\nymm529\n\n\nSweden\nTink Demo Bank\nu27678322\nvrh343\n\n\nUnited Kingdom\nTink Demo Bank\nu30315772\nndg370\n\n\nUnited States\nAny institution\nuser_good\nuser_good\n\n\n\nTroubleshoot hosted onboarding\nYou may need to troubleshoot if your user encounters issues during the hosted onboarding process. Hosted onboarding provides a browser-based user interface (UI) for you to use to debug. This tool allows you and your team to:\n\nDiagnose and resolve issues faced by your users during their onboarding.\nCollect necessary details about these issues for possible escalation to support or engineering teams.\n\nThe debug UI is enabled by default and is intended for use by your support and engineering teams, not by your marketplace users. You can control the availability of the debug UI by adjusting the \n  allowDebugUi\n setting when creating an onboarding link.\nTo access the debug UI:\n\nPress Ctrl + Shift + \\ on your keyboard while in the hosted onboarding page. A comprehensive report of debug information will appear.\nTo share the report, select Copy debug info at the bottom and include it in your support request.\n\n\nNote that the debug report contains sensitive information and must be treated cautiously and to the minimum required extent. Only share this information with your team or Adyen Support for troubleshooting purposes.\n\nThe debug report includes:\n\nMetadata: Information about the SDK version, the user's locale, and the ID of the main legal entity.\nExperiments and Settings: A list of enabled and disabled features (also known as experiments), along with the settings that were specified when creating an onboarding link.\nTask Statuses: Information on onboarding tasks that the user needs to complete, along with their current statuses. You can also see why a task shows a specific status, such as verification errors or missing data.\nLegal Entity Data: Information about the main legal entity linked to the account holder. Here, you can review the entire JSON response for the main legal entity, including entity associations and capabilities of the corresponding account holder.\n\n","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Marketplaces","lvl2":"Onboard and verify users","lvl3":"Customize and test hosted onboarding"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/marketplaces","lvl2":"https:\/\/docs.adyen.com\/pt\/marketplaces\/onboard-users","lvl3":"\/pt\/marketplaces\/onboard-users\/customize-hosted-onboarding"},"levels":4,"category":"Marketplaces","category_color":"green","tags":["Customize","hosted","onboarding"]},"articleFiles":{"tasks.svg":"<img alt=\"\" src=\"https:\/\/docs.adyen.com\/user\/pages\/docs\/04.marketplaces\/10.onboard-users\/04.customize-hosted-onboarding\/tasks.svg\" \/>"}}