--- title: "Get a link to an Adyen-hosted onboarding page" method: POST path: "/legalEntities/{id}/onboardingLinks" tags: ["Hosted Onboarding"] --- # Get a link to an Adyen-hosted onboarding page `POST /legalEntities/{id}/onboardingLinks` 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. ## Path parameters - `id` string, required ## Request body - OnboardingLinkInfo - `locale` string — The language that will be used for the page, specified by a combination of two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language and [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. See possible valuesfor [marketplaces](https://docs.adyen.com/marketplaces/onboard-users/hosted#supported-languages) or [platforms](https://docs.adyen.com/platforms/onboard-users/hosted#supported-languages). 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. - `redirectUrl` string — The URL where the user is redirected after they complete hosted onboarding. - `settings` OnboardingLinkSettings - `acceptedCountries` string[] — The 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](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code format. The array is empty by default, allowing all [countries and regions supported by hosted onboarding](https://docs.adyen.com/platforms/onboard-users/#hosted-onboarding). - `allowBankAccountFormatSelection` boolean — Default value: **false** Indicates if the user can select the format for their payout account (if applicable). - `allowDebugUi` boolean — Default value: **true** Indicates whether the debug user interface (UI) is enabled. The debug UI provides information for your support staff to diagnose and resolve user issues during onboarding. It can be accessed using a keyboard shortcut. - `allowIntraRegionCrossBorderPayout` boolean — Default value: **false** Indicates if 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. - `changeLegalEntityType` boolean — Default value: **true** Indicates if the user can change their legal entity type. - `editPrefilledCountry` boolean — Default value: **true** Indicates if the user can change the country of their legal entity's address, for example the registered address of an organization. - `enforceLegalAge` boolean — Default value: **false** Indicates if only users above the age of 18 can be onboarded. - `hideOnboardingIntroductionIndividual` boolean — Default value: **true** Indicates whether the 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. - `hideOnboardingIntroductionOrganization` boolean — Default value: **true** Indicates whether the 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. - `hideOnboardingIntroductionSoleProprietor` boolean — Default value: **true** Indicates whether the introduction screen is hidden for the user of the sole proprietorship legal entity type. The introduction screen provides brief instructions for the subsequent steps in the hosted onboarding process. - `hideOnboardingIntroductionTrust` boolean — Default value: **true** Indicates whether the introduction screen is hidden for the user of the trust legal entity type. The introduction screen provides brief instructions for the subsequent steps in the hosted onboarding process. - `instantBankVerification` boolean — Default value: **true** Indicates if the user can initiate the verification process through open banking providers, like Plaid or Tink. - `requirePciSignEcomMoto` boolean — Default value: **false** Indicates if the user is required to sign a PCI questionnaires for the **ecomMoto** sales channel type. - `requirePciSignEcommerce` boolean — Default value: **false** Indicates if the user is required to sign a PCI questionnaires for the **eCommerce** sales channel type. - `requirePciSignPos` boolean — Default value: **false** Indicates if the user is required to sign a PCI questionnaires for the **pos** sales channel type. - `requirePciSignPosMoto` boolean — Default value: **false** Indicates if the user is required to sign a PCI questionnaires for the **posMoto** sales channel type. - `transferInstrumentLimit` integer — The maximum number of transfer instruments the user can create. - `themeId` string — The unique identifier of the hosted onboarding theme. ## Response `200` OK - the request has succeeded. - OnboardingLink - `url` string — 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. ## Other responses - `400` — Bad Request - a problem reading or understanding the request. - `401` — Unauthorized - authentication required. - `403` — Forbidden - insufficient permissions to process the request. - `422` — Unprocessable Entity - a request validation error. - `500` — Internal Server Error - the server could not process the request. --- [API](https://skmtc.net/adyen/apis/legalentityservice.md) · [All operations](https://skmtc.net/adyen/apis/legalentityservice/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/adyen/legalentityservice/revisions/d0097ab4e2e8/schema)