Account Verification

post

https://api.finx-s.qwist.cloud/onetime/account-verification

Start the onetime account verification flow.

Body Params

state

string

A client-provided identifier that helps track a specific user's journey through the widget flow. When you initially create the widget session, you can set this value to any string that helps identify the user's context (e.g., a session ID, user ID, or transaction reference). When the user completes their interaction and is redirected back to your redirect_uri, this same state value is returned as a query parameter. This mechanism allows you to securely match the returning user with their original session and maintain context about who they are and what they were doing, particularly important in scenarios with multiple concurrent widget sessions.

redirect_uri

url

required

The URL where users will be redirected after completing their interaction with the Widget.

The redirect includes the following query parameters:

state: Your original state value passed during initialization
success: Boolean indicating whether the flow completed successfully
cancel: Boolean indicating if the user canceled the flow (only present when canceled)
code: Authorization code valid for 1 hour, used to obtain an access token (only present on successful completion)
flow_id: Unique identifier for accessing flow-specific resources

language

string

enum

The display language used in the Widget UI.

Allowed:

name

string

required

The alleged name of the account holder.

account

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

Restricts which account types users can select during the connection flow. Use this to limit account selection to specific types (e.g., only Giro accounts). When empty, all account types are available for selection.

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

Responses

201Widget link created

400Bad request.

401You are not authorized.