POST /legalEntities/{id}/onboardingLinks
Returns a link to an Adyen-hosted onboarding page where you need to redirect your user.
Servers
- https://kyc-test.adyen.com/lem/v3
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
The unique identifier of the legal entity |
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 |
|---|---|---|---|
themeId |
String | No |
The unique identifier of the hosted onboarding theme. |
redirectUrl |
String | No |
The URL where the user is redirected after they complete hosted onboarding. |
locale |
String | No |
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. |
settings |
Object | No |
Key-value pairs indicating the settings for the hosted onboarding page. The key represents a specific setting. |
settings.changeLegalEntityType |
Boolean | No |
Default value: true Indicates if the user can change their legal entity type. |
settings.hideOnboardingIntroductionIndividual |
Boolean | No |
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. |
settings.requirePciSignPos |
Boolean | No |
Default value: false Indicates if the user is required to sign a PCI questionnaires for the pos sales channel type. |
settings.allowIntraRegionCrossBorderPayout |
Boolean | No |
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. |
settings.requirePciSignEcommerce |
Boolean | No |
Default value: false Indicates if the user is required to sign a PCI questionnaires for the eCommerce sales channel type. |
settings.acceptedCountries[] |
Array | No |
The list of countries the user can choose from in hosted onboarding when The value must be in the two-character ISO 3166-1 alpha-2 country code format. The array is empty by default, allowing all countries and regions supported by hosted onboarding. |
settings.enforceLegalAge |
Boolean | No |
Default value: false Indicates if only users above the age of 18 can be onboarded. |
settings.requirePciSignEcomMoto |
Boolean | No |
Default value: false Indicates if the user is required to sign a PCI questionnaires for the ecomMoto sales channel type. |
settings.hideOnboardingIntroductionOrganization |
Boolean | No |
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. |
settings.hideOnboardingIntroductionTrust |
Boolean | No |
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. |
settings.transferInstrumentLimit |
Integer | No |
The maximum number of transfer instruments the user can create. |
settings.hideOnboardingIntroductionSoleProprietor |
Boolean | No |
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. |
settings.allowBankAccountFormatSelection |
Boolean | No |
Default value: false Indicates if the user can select the format for their payout account (if applicable). |
settings.instantBankVerification |
Boolean | No |
Default value: true Indicates if the user can initiate the verification process through open banking providers, like Plaid or Tink. |
settings.requirePciSignPosMoto |
Boolean | No |
Default value: false Indicates if the user is required to sign a PCI questionnaires for the posMoto sales channel type. |
settings.editPrefilledCountry |
Boolean | No |
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. |
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.