Get a link to a Adyen-hosted onboarding page

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.

Endpoint destination URL

https://cal-test.adyen.com/cal/services/Hop/v6/getOnboardingUrl
Click to copy

Request parameters

accountHolderCode string Required

The account holder code you provided when you created the account holder.

collectInformation

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.

editMode boolean

Indicates if editing checks is allowed even if all the checks have passed.

platformName string

The platform name which will show up in the welcome page.

returnUrl string

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.

shopperLocale string

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

Contains indicators whether specific pages must be shown to the account holder.

Response parameters

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.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show more Show less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less
  • Request
  • Click to copy
  • Response
  • Click to copy