Plaid Link Auth Flow

Plaid and DriveWealth have partnered to help customers seamlessly link bank accounts to their DriveWealth-supported investment products. DriveWealth offers the entire investor experience—everything from account creation through tax reporting—via a simple to use API. Using this integration, bank accounts connected via Plaid can be added to the DriveWealth platform for funding accounts or withdrawing money, without ever sharing sensitive account details.

To get started, sign up for Plaid API keys or try out the Plaid demo.

Getting Started

You'll first want to familiarize yourself with Plaid Link, a drop-in integration for the Plaid API that handles input validation, error handling, and multi-factor authentication. Your organization will also need to be an existing DriveWealth customer in order to add a bank funding source. If your organization isn’t working with Drivewealth already, please reach out to plaid@drivewealth.com.

Your customers will use Link to authenticate with their financial institution and select the bank account they wish to use for ACH transactions. From there, you'll receive a Plaid access_token and a DriveWealth processor_token, which allows you to quickly and securely verify a bank funding source via DriveWealth's API without having to store any sensitive banking information. Utilizing Plaid + DriveWealth enables a seamless workflow for sending and receiving payments.

Instructions

Step 1: Set up your Plaid and DriveWealth accounts

You'll need accounts at both Plaid and DriveWealth in order to use the Plaid + DriveWealth integration. You'll also need to enable your Plaid account for the DriveWealth integration.

First, you will need to work with the DriveWealth team to become a customer.

Next, verify that your Plaid account is enabled for the integration. If you do not have a Plaid account, create one. Your account will be automatically enabled for integration access.

To verify that your Plaid account is enabled for the integration, go to the Integrations section of the account dashboard.

If the integration is off, simply click the 'Enable' button for DriveWealth to enable the integration.

Step 2: Get your public_key

Your public_key is available from the Plaid Dashboard.

You have three different API keys

View in Dashboard

public_key

a non-sensitive, public identifier that is used to initialize Plaid Link


secret and client_id

private identifiers that are required for accessing any financial data

these should never be shared in client-side code

Your public_key is a less privileged version of your client_id and secret. It simply associates accounts you create using Plaid Link with your client_id. All Plaid API requests must be made using your private client_id and secret.

Step 3: Integrate with Plaid Link

Integrating with Link is easy. All it takes is a few lines of client-side JavaScript and a small server-side handler to exchange the Link public_token for a Plaid access_token and a DriveWealth processor_token.

Integrate with Link

See the parameter reference for complete documentation on possible configurations.

Plaid.create accepts one argument, a configuration Object, and returns an Object with two functions, open and exit . Calling open will display the "Institution Select" view and calling exit will close Link.

Step 4: Write server-side handler

Plaid’s Link module handles the entire onboarding flow securely and quickly, but does not actually retrieve account data for a user. Instead, the Link module returns a public_token and an account_id (a property on the metadata object) via the onSuccess callback.

This public_token must be exchanged for a Plaid access_token using the /item/public_token/exchange API endpoint. Once you have the access_token for the Item, you'll create a DriveWealth processor_token. You'll send this token to DriveWealth and they will use it to securely retrieve account and routing numbers from Plaid.

You can create valid DriveWealth processor_tokens in the following Plaid API environments:

Server-side handler

const plaid = require('plaid');

// Change sandbox to development to test with live users;
// Change to production when you're ready to go live!
const plaidClient = new plaid.Client(
  PLAID_CLIENT_ID,
  PLAID_SECRET,
  PLAID_PUBLIC_KEY,
  plaid.environments.sandbox
);

// Exchange the public_token from Plaid Link for an access token.
plaidClient.exchangePublicToken(public_token, function(err, res) {
  const accessToken = res.access_token;
  // Create a processor token for a specific account id.
  plaidClient.createProcessorToken(
    accessToken,
    accountId,
    'drivewealth',
    function(err, res) {
      const processorToken = res.processor_token;
    }
  );
});

# Exchange the public token from Plaid Link for an access token.
curl \
  -H 'Content-Type: application/json' \
  -d '{
    "client_id": "PLAID_CLIENT_ID",
    "secret": "PLAID_SECRET",
    "public_token": "PUBLIC_TOKEN"
  }' \
  -X POST \
  https://sandbox.plaid.com/item/public_token/exchange

# Create a processor token for a specific account id.
curl \
  -H 'Content-Type: application/json' \
  -d '{
    "client_id": "PLAID_CLIENT_ID",
    "secret": "PLAID_SECRET",
    "access_token": "ACCESS_TOKEN",
    "account_id": "ACCOUNT_ID",
    "processor": "drivewealth"
  }' \
  -X POST \
  https://sandbox.plaid.com/processor/token/create

require 'plaid'

# Change sandbox to development to test with live users;
# Change to production when you're ready to go live!
client = Plaid::Client.new(env: :sandbox,
                           client_id: PLAID_CLIENT_ID,
                           secret: PLAID_SECRET,
                           public_key: PLAID_PUBLIC_KEY)

# Exchange the public token from Plaid Link for an access token.
exchange_response = client.item.public_token.exchange(public_token)
access_token = exchange_response.access_token

# Create a processor token for a specific account id.
create_response = client.processor_token.create(access_token, account_id, "drivewealth")
processor_token = create_response.processor_token

// Support Coming Soon

from plaid import Client

# Change sandbox to development to test with live users;
# Change to production when you're ready to go live!
client = Client(
  PLAID_CLIENT_ID,
  PLAID_SECRET,
  PLAID_PUBLIC_KEY,
  'sandbox'
)

# Exchange the public token from Plaid Link for an access token.
exchange_token_response = client.Item.public_token.exchange(public_token)
access_token = exchange_token_response['access_token']

# Create a processor token for a specific account id.
create_response = client.Processor.ProcessorTokenCreate(access_token, account_id, "drivewealth")
processor_token = create_response['processor_token']

For a valid request, the API will return a JSON response similar to:

Processor Token response

{
"processor_token": "processor-sandbox-0asd1-a92nc",
"request_id": "[Unique request ID]"
}

For possible error codes, see the full listing of Plaid error codes.

Step 5: Test with sandbox credentials

Link's sandbox mode is compatible with Plaid's Sandbox API environment. To test the integration in sandbox mode, simply use the Plaid sandbox credentials along with your public_key.

Step 6: Get ready for production

Your account is immediately enabled for our sandbox environment. To move to Production, please request access from the Dashboard. You will want to ensure that you have valid DriveWealth Production credentials prior to verifying bank funding sources in the DriveWealth API with Plaid.

Support and questions

Find answers to many common integration questions and concerns—such as pricing, sandbox and test mode usage, and more—at our Help Center and docs.

If you're still stuck, open a support ticket with information describing the issue that you're experiencing and we'll get back to you as soon as we can.