Get a link to an Adyen-hosted onboarding page

post/legalEntities/{id}/onboardingLinks

API Version

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

Endpoint destination URL

https://kyc-test.adyen.com/lem/v2/legalEntities/{id}/onboardingLinks

Path Parameters

Required

Optional

The unique identifier of the legal entity

Request Parameters

Required

Optional

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.

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

Key-value pairs indicating the settings for the hosted onboarding page. The key represents a specific setting.

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 country code format.

The array is empty by default, allowing all countries and regions supported by hosted onboarding.

Default value: false

Indicates if the user can select the format for their payout account (if applicable).

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.

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.

Default value: true

Indicates if the user can change their legal entity type.

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.

Default value: false

Indicates if only users above the age of 18 can be onboarded.

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.

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.

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.

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.

Default value: true

Indicates if the user can initiate the verification process through open banking providers, like Plaid or Tink.

Default value: false

Indicates if the user is required to sign a PCI questionnaires for the ecomMoto sales channel type.

Default value: false

Indicates if the user is required to sign a PCI questionnaires for the eCommerce sales channel type.

Default value: false

Indicates if the user is required to sign a PCI questionnaires for the pos sales channel type.

Default value: false

Indicates if the user is required to sign a PCI questionnaires for the posMoto sales channel type.

The maximum number of transfer instruments the user can create.

The unique identifier of the hosted onboarding theme.

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.
urlstring
The URL of the hosted onboarding page where you need to redirect your user. This URL expires after 4 minutes and can only be used once.

If the link expires, you need to create a new link.
400 - Bad Request
A problem reading or understanding the request.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
401 - Unauthorized
Authentication required.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
403 - Forbidden
Insufficient permissions to process the request.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
422 - Unprocessable Entity
A request validation error.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
500 - Internal Server Error
The server could not process the request.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.

Get a link to an Adyen-hosted onboarding page

HTTP Responses

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error