POST /getOnboardingUrl

Returns a link to an Adyen-hosted onboarding page (HOP) that you can send to your account holder. For more information on how to use HOP, refer to Hosted onboarding.

Servers

https://cal-test.adyen.com/cal/services/Hop/v6

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`collectInformation`	Object	No	Contains indicators whether the page should only collect information for specific KYC checks. By default, the page collects information for all KYC checks that apply to the legal entity type.
`collectInformation.pciQuestionnaire`	Boolean	No	Indicates whether answers to a PCI questionnaire must be collected. Applies only to partner platforms. Default is true.
`collectInformation.individualDetails`	Boolean	No	Indicates whether individual details must be collected. Default is true.
`collectInformation.shareholderDetails`	Boolean	No	Indicates whether shareholder details must be collected. Defaults to true.
`collectInformation.bankDetails`	Boolean	No	Indicates whether bank account details must be collected. Default is true.
`collectInformation.legalArrangementDetails`	Boolean	No	Indicates whether legal arrangement details must be collected. Default is true.
`collectInformation.businessDetails`	Boolean	No	Indicates whether business details must be collected. Default is true.
`platformName`	String	No	The platform name which will show up in the welcome page.
`returnUrl`	String	No	The URL where the account holder will be redirected back to after they complete the onboarding, or if their session times out. Maximum length of 500 characters. If you don't provide this, the account holder will be redirected back to the default return URL configured in your platform account.
`editMode`	Boolean	No	Indicates if editing checks is allowed even if all the checks have passed.
`mobileOAuthCallbackUrl`	String	No	The URL to which the account holder is redirected after completing an OAuth authentication with a bank through Trustly/PayMyBank.
`shopperLocale`	String	No	The language to be used in the page, specified by a combination of a language and country code. For example, pt-BR. 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. For a list of supported languages, refer to Change the page language.
`showPages`	Object	No	Contains indicators whether specific pages must be shown to the account holder.
`showPages.welcomePage`	Boolean	No	Indicates whether the welcome page must be shown. Defaults to false.
`showPages.manualBankAccountPage`	Boolean	No	Indicates whether the page to manually add bank account' details must be shown. Defaults to true.
`showPages.bankDetailsSummaryPage`	Boolean	No	Indicates whether the page with bank account details must be shown. Defaults to true.
`showPages.individualDetailsSummaryPage`	Boolean	No	Indicates whether the page with the individual's details must be shown. Defaults to true.
`showPages.legalArrangementsDetailsSummaryPage`	Boolean	No	Indicates whether the page with the legal arrangements' details must be shown. Defaults to true.
`showPages.bankVerificationPage`	Boolean	No	Indicates whether the bank check instant verification' details must be shown. Defaults to true.
`showPages.businessDetailsSummaryPage`	Boolean	No	Indicates whether the page with the company's or organization's details must be shown. Defaults to true.
`showPages.checksOverviewPage`	Boolean	No	Indicates whether the checks overview page must be shown. Defaults to false.
`showPages.shareholderDetailsSummaryPage`	Boolean	No	Indicates whether the page with the shareholders' details must be shown. Defaults to true.
`accountHolderCode`	String	Yes	The account holder code you provided when you created the account holder.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.