Bank Account Verification Integration

Integration guide

Web SDK guide

This guide provides step-by-step instructions on how to integrate Bank Account Verification with the Web SDK.

Before you begin, make sure you have completed the following:


Flow

Click to magnify



1. Authenticate

Create an access token to authenticate in our API:

  • You provide your Fourthline API key.
  • You receive an access_token.

API Reference – Create access token

Important
For security, access tokens are valid for 1 hour only.
If your token expires, make another Create access token request.


2. Create workflow

Create a Bank Account Verification workflow:

  • You specify the workflowName and provide your unique identifier for the client.
  • You receive a workflowId and a Fourthline clientId.

API Reference – Create workflow

Status: The reference payment status changes to new.


3. Create SDK session

Create the Web SDK session:

  • You provide the workflowId.
  • You receive a validationCode to pass to the SDK in your backend.

If the client starts on your website in their:

  • Desktop browser: Initialize the Web SDK, display the redirect options, and redirect the client to the workflow in their mobile browser.
  • Mobile browser: Display the redirect options and then redirect them to the workflow on your subdomain.

API Reference – Create SDK session

Important
• SDK validation codes are single use and expire after 2 hours.
• If the client stops in the middle of the workflow, you need to create a new SDK session.
• When the client closes the browser, the validationCode is invalidated and cleared from the cache.

Status: The payment status changes to one of the following and we send the relevant webhook notification:

StatusDescriptionAction
pendingThe reference payment is being processed.Wait for completed status.
kyc_required• The client's Identity Verification case was unsuccessful.
or
• There is no Identity Verification case for this client.
Create a new workflow that includes IDV and BAV.
completedThe reference payment was successfully processed.
failedThe reference payment failed.
For the specific reason, check the accompanying status code.
Create a new workflow for BAV only.


4. Check reference payment status

Check the reference payment status:

API Reference – Get reference payment status

Success
Success
You have integrated Bank Account Verification for web!

Top of page