Add Identity to your app

Use Identity to verify user data

In this guide, we'll start from scratch and walk through how to use Identity to retrieve identity data. If you are already familiar with using Plaid and are set up to make calls to the Plaid API, you can skip ahead to Fetching identity data.

Get Plaid API keys

If you don't already have one, you'll need to create a Plaid developer account. After creating your account, you can find your API keys under the Team Settings menu on the Plaid developer dashboard.

Install Plaid libraries

You can use our official libraries to connect to the Plaid API from your application:

Select group for content switcher
1# Install via npm
2npm install --save plaid

Create an Item in Link

Plaid Link is a drop-in module that provides a secure, elegant authentication flow for each institution that Plaid supports. Link makes it secure and easy for users to connect their bank accounts to Plaid. Note that these instructions cover Link on the web. For instructions on using Link within mobile apps, see the Link documentation.

Using Link, we will create a Plaid Item, which is a Plaid term for a login at a financial institution. An Item is not the same as a financial institution account, although every account will be associated with an Item. For example, if a user has one login at their bank that allows them to access both their checking account and their savings account, a single Item would be associated with both of those accounts. If you want to customize Link's look and feel, you can do so from the Dashboard.

Before initializing Link, you will need to create a new link_token on the server side of your application. A link_token is a short-lived, one-time use token that is used to authenticate your app with Link. You can create one using the /link/token/create endpoint. Then, on the client side of your application, you'll need to initialize Link with the link_token that you just created.

In the code samples below, you will need to replace PLAID_CLIENT_ID and PLAID_SECRET with your own keys, which you can obtain from the Dashboard.

Create a link_token
Select group for content switcher
1// Using Express
2const express = require('express');
3const app = express();
4app.use(express.json());
5
6const { Configuration, PlaidApi, PlaidEnvironments } = require('plaid');
7
8const configuration = new Configuration({
9  basePath: PlaidEnvironments[process.env.PLAID_ENV],
10  baseOptions: {
11    headers: {
12      'PLAID-CLIENT-ID': process.env.PLAID_CLIENT_ID,
13      'PLAID-SECRET': process.env.PLAID_SECRET,
14    },
15  },
16});
17
18const client = new PlaidApi(configuration);
19
20app.post('/api/create_link_token', async function (request, response) {
21  // Get the client_user_id by searching for the current user
22  const user = await User.find(...);
23  const clientUserId = user.id;
24  const request = {
25    user: {
26      // This should correspond to a unique id for the current user.
27      client_user_id: clientUserId,
28    },
29    client_name: 'Plaid Test App',
30    products: [Products.Identity],
31    language: 'en',
32    webhook: 'https://webhook.example.com',
33    country_codes: [CountryCode.Us],
34  };
35  try {
36    const createTokenResponse = await client.linkTokenCreate(request);
37    response.json(createTokenResponse.data);
38  } catch (error) {
39    // handle error
40  }
41});
Install Link dependency
1<head>
2  <title>Connect a bank</title>
3  <script src="https://cdn.plaid.com/link/v2/stable/link-initialize.js"></script>
4</head>
Configure the client-side Link handler
1const linkHandler = Plaid.create({
2  token: (await $.post('/create_link_token')).link_token,
3  onSuccess: (public_token, metadata) => {
4    // Send the public_token to your app server.
5    $.post('/exchange_public_token', {
6      public_token: public_token,
7    });
8  },
9  onExit: (err, metadata) => {
10    // Optionally capture when your user exited the Link flow.
11    // Storing this information can be helpful for support.
12  },
13  onEvent: (eventName, metadata) => {
14    // Optionally capture Link flow events, streamed through
15    // this callback as your users connect an Item to Plaid.
16  },
17});
18
19linkHandler.open();

Get a persistent access_token

Next, on the server side, we need to exchange our public_token for an access_token and item_id. The access_token will allow us to make authenticated calls to the Plaid API. Doing so is as easy as calling the /item/public_token/exchange endpoint from our server-side handler. We'll use the client library we configured earlier to make the API call.

Save the access_token and item_id in a secure datastore, as they’re used to access Item data and identify webhooks, respectively. The access_token will remain valid unless you actively chose to expire it via rotation or remove the corresponding Item via /item/remove. The access_token should be stored securely, and never in client-side code. A public_token is a one-time use token with a lifetime of 30 minutes, so there is no need to store it.

Select group for content switcher
1// Using Express
2const express = require('express');
3const app = express();
4app.use(express.json());
5
6const { Configuration, PlaidApi, PlaidEnvironments } = require('plaid');
7
8const configuration = new Configuration({
9  basePath: PlaidEnvironments[process.env.PLAID_ENV],
10  baseOptions: {
11    headers: {
12      'PLAID-CLIENT-ID': process.env.PLAID_CLIENT_ID,
13      'PLAID-SECRET': process.env.PLAID_SECRET,
14      'Plaid-Version': '2020-09-14',
15    },
16  },
17});
18
19const client = new PlaidApi(configuration);
20
21app.post('/api/exchange_public_token', async function (
22  request,
23  response,
24  next,
25) {
26  const publicToken = request.body.public_token;
27  try {
28    const response = await client.itemPublicTokenExchange({
29      public_token: publicToken,
30    });
31    const accessToken = response.data.access_token;
32    const itemID = response.data.item_id;
33  } catch (error) {
34    // handle error
35  }
36});

Fetching Identity data

Now that the authentication step is out of the way, we can begin using authenticated endpoints from the Plaid API. Once you've retrieved identity data for an account, you can then use it to collect end-user contact information or evaluate whether they may constitute a fraud risk. For more detailed information on the schema for account information returned by /identity/get, see the Identity Reference.

Select group for content switcher
1// Pull Identity data for an Item
2const request: IdentityGetRequest = {
3  access_token: accessToken,
4};
5try {
6  const response = await plaidClient.identityGet(request);
7  const identities = response.data.accounts.flatMap(
8    (account) => account.owners,
9  );
10} catch (error) {
11  // handle error
12}

Example response data is below.

1{
2  "accounts": [
3    {
4      "account_id": "BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp",
5      "balances": {
6        "available": 100,
7        "current": 110,
8        "iso_currency_code": "USD",
9        "limit": null,
10        "unofficial_currency_code": null
11      },
12      "mask": "0000",
13      "name": "Plaid Checking",
14      "official_name": "Plaid Gold Standard 0% Interest Checking",
15      "owners": [
16        {
17          "addresses": [
18            {
19              "data": {
20                "city": "Malakoff",
21                "country": "US",
22                "postal_code": "14236",
23                "region": "NY",
24                "street": "2992 Cameron Road"
25              },
26              "primary": true
27            },
28            {
29              "data": {
30                "city": "San Matias",
31                "country": "US",
32                "postal_code": "93405-2255",
33                "region": "CA",
34                "street": "2493 Leisure Lane"
35              },
36              "primary": false
37            }
38          ],
39          "emails": [
40            {
41              "data": "accountholder0@example.com",
42              "primary": true,
43              "type": "primary"
44            },
45            {
46              "data": "accountholder1@example.com",
47              "primary": false,
48              "type": "secondary"
49            }
50          ],
51          "names": ["Alberta Bobbeth Charleson"],
52          "phone_numbers": [
53            {
54              "data": "1112223333",
55              "primary": false,
56              "type": "home"
57            },
58            {
59              "data": "1112224444",
60              "primary": false,
61              "type": "work"
62            },
63            {
64              "data": "1112225555",
65              "primary": false,
66              "type": "mobile1"
67            }
68          ]
69        }
70      ],
71      "subtype": "checking",
72      "type": "depository"
73    }
74  ],
75  "item": {
76    "available_products": ["balance", "credit_details", "investments"],
77    "billed_products": [
78      "assets",
79      "auth",
80      "identity",
81      "liabilities",
82      "transactions"
83    ],
84    "consent_expiration_time": null,
85    "error": null,
86    "institution_id": "ins_3",
87    "item_id": "eVBnVMp7zdTJLkRNr33Rs6zr7KNJqBFL9DrE6",
88    "webhook": "https://www.genericwebhookurl.com/webhook"
89  },
90  "request_id": "3nARps6TOYtbACO"
91}

Example code in Plaid Pattern

For a real-life example of an app that incorporates Identity, see the Node-based Plaid Pattern Account Funding sample app. Pattern Account Funding is a sample account funding app that fetches Identity data in order verify identity prior to a funds transfer. The Identity code can be found in items.js