vConnect Widget

Bank Lookup Endpoint

The Bank Lookup endpoint allows you to determine the status of a bank before launching vConnect.

Here's the basic flow:

Call our API to search for a bank
Send the BankID into vConnect to pre-select a bank or force the customer to a bank

Search for a bank

To search for a bank, call the CONNECT/Banks endpoint. The endpoint accepts one string search phrase. The search phrase can either be a 9 digit routing number or part of a name of a bank.

GET /v4/CONNECT/Banks?search=123456789

Headers:
-- content-type:  application/json
-- authorization: Bearer <token from POST /v4/token endpoint>

Response

The API will bring back a list of matching banks. If the list is empty, then no search results were found.

[
  {
    "BankID" : 12345,
    "BankName" : "RIBBIT Bank",
    "BankLoginStatus" : "Active, Inactive, or Unavailable",
    "EnrollmentStatus" : "Bank Login or Manual Login"
  },
  {
    "BankID" : 1111,
    "BankName" : "RIBBIT Credit Union",
    "BankLoginStatus" : "Active, Inactive, or Unavailable",
    "EnrollmentStatus" : "Bank Login or Manual Login"
  }
]

BankID

The BankID identifies the bank, and can be used to pass into vConnect to pre-load a bank or force a customer to a specific bank

BankName

The name of the bank

EnrollmentStatus

The status can be one of these values:

Bank Login - This bank supports online login
Manual Login - This bank does not support online login - the only option is for the user to enter their routing and account numbers / BankVERIFY+

BankLoginStatus

The status can be one of these values:

Active - The bank is active
Inactive - This bank is temporarily having issues
Unavailable - We are not able to log in to this institution

Sending the BankID to vConnect

Once the correct bank is retrieved from the API, pass the BankID in to the settings.bankId parameter when creating a vConnect session.

If a bankId is provided to vConnect, the customer will be forced to connect to that bank.

Example of supplying a bankId to vConnect:

{
    "token" : {
       "clientId" : "Your ValidiFI Client ID",
       "clientSecret" : "Your ValidiFI Client Secret"
    },
    "customer" : { ... },
    "terms" : { ... },
    "settings" : {
           "bankId" : "1234567"
    }
}

Developer Docs