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.

Endpoint destination URL

https://kyc-test.adyen.com/lem/v3/legalEntities/{id}/onboardingLinks
Click to copy

Path parameters

id string Required

The unique identifier of the legal entity

Request parameters

locale string

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 values.

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 object

Boolean key-value pairs indicating the settings for the hosted onboarding page. The keys are the settings. By default, the values are set to true. Set to false to not allow the action.

Possible keys:

  • changeLegalEntityType: The user can change their legal entity type.

  • editPrefilledCountry: The user can change the country of their legal entity's address, for example the registered address of an organization.

themeId string

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.

    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