Sign in

v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-143490310.6 KB
Hosted Onboarding

Get a link to an Adyen-hosted onboarding page

Returns a link to an Adyen-hosted onboarding page where you need to redirect your user.

Requests to this endpoint are subject to rate limits:

  • Live environments: 700 requests per 5 seconds.

  • Test environments: 200 requests per 5 seconds.

  • Failed requests are subject to a limit of 5 failures per 10 seconds.

post/legalEntities/{id}/onboardingLinks

Path parameters

idstring required

The unique identifier of the legal entity

Request body

localestring

The language that will be used for the page, specified by a combination of two letter ISO 639-1 language and ISO 3166-1 alpha-2 country codes. See possible valuesfor marketplaces or platforms.

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.

redirectUrlstring

The URL where the user is redirected after they complete hosted onboarding.

themeIdstring

The unique identifier of the hosted onboarding theme.

Response

OK - the request has succeeded.

urlstring

The URL of the hosted onboarding page where you need to redirect your user. This URL:

  • Expires after 4 minutes.

  • Can only be used once.

  • Can only be clicked once by the user.

If the link expires, you need to create a new link.