Account Verification

Start the onetime account verification flow.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

An opaque value provided by the partner in order to maintain state between this request and the eventual callback. The widget UI includes this value when redirecting the user-agent back to the partner and allows to identify the initiated Widget flow.

url
required

After completing its interaction with the user, the Widget UI directs the user's user-agent to this redirection endpoint. The callback includes state, success and flow_id as query parameters.

  • state: This value is provided upon flow initiation and can be used to track state on the partner side.
  • success: Indicates if the flow was successfully finished.
  • flow_id: A unique ID to identify a specific Widget flow.
string

The display language used in the Widget UI.

string
required

The alleged name of the account holder.

string

The IBAN of the account to be verified. If this value is provided the bank- and account-selection is automatically performed by the Widget, so that the user only has to take care of the authentication and authorization when connecting the account. If this value is left empty the user will be presented with a search-screen to select a bank institute and eventually a bank account to be used for the verification.

account_types
array of objects
Defaults to []

Limits the type of accounts that can be selected throughout the flow. Use this field if you only want to allow your users to select/connect certain types of accounts (i.e Current accounts).

account_types
readout
array of strings
Defaults to []

Defines entries that shall be available for a readout after the account verification is done. Depending on the values provided the account information and transaction history of the verified account can be retrieved.

readout
Allowed:
Responses

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