requestOnlineOnboardingURL

open suspend override fun requestOnlineOnboardingURL(firstName: String, lastName: String, street: String, houseNumber: String, city: String, postalCode: String, countryCode: String, dateOfBirth: LocalDate, phoneNumber: String?, userId: String, email: String, successRedirect: String, failureRedirect: String, abortRedirect: String): String

Function to provide user information details and obtain an URL to the 3rd party provider for importing the user's bank account.

Except for the user phone number, all fields are mandatory.

A URL string to the third-party provider for bank account import.

firstName

The user's first name. Must not be blank.

lastName

The user's last name. Must not be blank.

street

The user's street address. Must not be blank.

houseNumber

The user's house number. Must not be blank.

city

The user's city. Must not be blank.

postalCode

The user's postal code. Must be a valid German postal code (exactly 5 digits).

countryCode

The user's country code. Must be a valid 2-character ISO 3166-1 alpha-2 country code.

dateOfBirth

The user's date of birth. Must be in the past.

phoneNumber

The user's phone number. Optional. Only digits, plus (+), dashes (-) and spaces are allowed.

userId

The user's unique identifier. Must not be blank and no longer than 36 characters.

The user's email address. Must not be blank and must follow the standard local-part@domain.tld email format.

successRedirect

URI to redirect to on successful onboarding.

failureRedirect

URI to redirect to on onboarding failure.

abortRedirect

URI to redirect to if the 3rd party bank account import flow is aborted.

if the startOnlineOnboarding was not called

if URL cannot be generated.

if user info cannot be validated. The error provides the field that failed the validation process.