Returns a link to an Adyen-hosted onboarding page where you need to redirect your user.
If you are using hosted onboarding, only use v2 for your API requests.
The unique identifier of the legal entity
If not specified in the request or if the language is not supported, the page uses the browser language. If the browser language is not supported, the page uses en-US by default.
The URL where the user is redirected after they complete hosted onboarding.
Boolean key-value pairs indicating the settings for the hosted onboarding page. The keys are the settings.
By default, these values are set to true. Set to false to not allow the action.
changeLegalEntityType: The user can change their legal entity type.
editPrefilledCountry: The user can change the country of their legal entity's address, for example the registered address of an organization.
By default, this value is set to false. Set to true to allow the action.
allowBankAccountFormatSelection: The user can select the format for their payout account if applicable.
allowIntraRegionCrossBorderPayout: The user can select a payout account in a different EU/EEA country than the country of their legal entity.
The unique identifier of the hosted onboarding theme.
After submitting a call, you receive a response message to inform you that your request was received and processed.
Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.
The request has succeeded.Show more
A problem reading or understanding the request.Show more
Authentication required.Show more
Insufficient permissions to process the request.Show more
A request validation error.Show more
The server could not process the request.Show more