Start Legal Entity Online Onboarding

Initiates the online onboarding process for a legal entity whose profile status is AWAITING_INFORMATION. This call generates a secure onboarding session and returns a redirect URL where the end-user can complete their onboarding (e.g., KYC checks, document uploads).

Validation notes

  • UBO other name (ubos[].otherName): optional. The name character policy applies (see Validation Rules for Legal Entities). A value with no valid name character, for example 123 or @@@, is rejected with 400 and ubo otherName must be set. An empty string is rejected with 400 and ubos.0.otherName should not be empty. A value with at least one valid name character, for example Marie2, is accepted.

  • Website (legalEntity.website): a single URL. Two URLs, separated by a space or a comma, are rejected with 400 and website is not in valid format.

    The full list of messages is on the Onboarding API: Error Messages page.

    For more information on validation rules, see: Validation Rules for Legal Entities

Downloads:

Body Params
string
required

UUID of the previously created account

string

URL to which the user will be redirected after completing onboarding

legalEntity
object
required

Legal entity details (see nested bodyParams below)

legalRepresentative
object
required

Legal representative details (see nested bodyParams below)

ubos
array of objects
ubos
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json