Create an Asset Report

Learn how to create Asset Reports with the Assets product

In this guide, we'll start from scratch and walk through how to use Assets to generate and retrieve Asset Reports. If a user's Asset Report involves data from multiple financial institutions, the user will need to allow access to each institution, which will in turn enable you to access their data from each institution. If you are already familiar with using Plaid and are set up to make calls to the Plaid API, you can skip ahead to Creating Asset Reports.

Get Plaid API keys and complete application and company profile

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 Dashboard.

You will also need to complete your application profile and company profile in the Dashboard. This will provide basic information about your app to help users manage their connection on the Plaid Portal at my.plaid.com. The application profile and company profile must be completed before connecting to certain institutions in Production.

Install and initialize Plaid libraries

You can use our official server-side client libraries to connect to the Plaid API from your application:

Terminal
Select Language
1// Install via npm
2npm install --save plaid

After you've installed Plaid's client libraries, you can initialize them by passing in your client_id, secret, and the environment you wish to connect to (Sandbox or Production). This will make sure the client libraries pass along your client_id and secret with each request, and you won't need to explicitly include it in any other calls.

server.js
Select Language
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.sandbox,
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);

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. Asset Reports can consist of user data from multiple financial institutions; users will need to use Link to provide access to each financial institution, providing you with multiple Items. 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. Since, for Assets, users may need to grant access to more than one financial institution via Link, you may need to initialize Link more than once.

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

server.js
Select Language
1app.post('/api/create_link_token', async function (request, response) {
// Get the client_user_id by searching for the current user
const user = await User.find(...);
const clientUserId = user.id;
const request = {
  user: {
    // This should correspond to a unique id for the current user.
    client_user_id: clientUserId,
  },
  client_name: 'Plaid Test App',
  products: ['assets'],
  language: 'en',
  webhook: 'https://webhook.example.com',
  redirect_uri: 'https://domainname.com/oauth-page.html',
  country_codes: ['US'],
};
try {
  const createTokenResponse = await client.linkTokenCreate(request);
  response.json(createTokenResponse.data);
} catch (error) {
  // handle error
}
23});

Install Link dependency

index.html
Select Language
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

app.js
1const linkHandler = Plaid.create({
token: (await $.post('/create_link_token')).link_token,
onSuccess: (public_token, metadata) => {
  // Send the public_token to your app server.
  $.post('/exchange_public_token', {
    public_token: public_token,
  });
},
onExit: (err, metadata) => {
  // Optionally capture when your user exited the Link flow.
  // Storing this information can be helpful for support.
},
onEvent: (eventName, metadata) => {
  // Optionally capture Link flow events, streamed through
  // this callback as your users connect an Item to Plaid.
},
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 for each Item the user provided you with via Link. The access_token will allow us to make authenticated calls to the Plaid API for its corresponding financial institution. 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_tokens and item_ids in a secure datastore, as they’re used to access Item data and identify webhooks, respectively. An access_token will remain valid unless you actively chose to expire it via rotation or remove the corresponding Item via /item/remove. An 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

server.js
Select Language
1app.post('/api/exchange_public_token', async function (
2  request,
3  response,
4  next,
5) {
6  const publicToken = request.body.public_token;
7  try {
8    const response = await client.itemPublicTokenExchange({
9      public_token: publicToken,
10    });
11
12    // These values should be saved to a persistent database and
13    // associated with the currently signed-in user
14    const accessToken = response.data.access_token;
15    const itemID = response.data.item_id;
16
17    res.json({ public_token_exchange: 'complete' });
18  } catch (error) {
19    // handle error
20  }
21});

Creating Asset Reports

Now that the authentication step is out of the way, we can begin using authenticated endpoints from the Plaid API and create an Asset Report using the /asset_report/create endpoint.

Assets sample request: create

Select group for content switcher

 
Select Language
1const { AssetReportCreateRequest } = require('plaid');
2
3const daysRequested = 90;
4const options = {
5  client_report_id: '123',
6  webhook: 'https://www.example.com',
7  user: {
8    client_user_id: '789',
9    first_name: 'Jane',
10    middle_name: 'Leah',
11    last_name: 'Doe',
12    ssn: '123-45-6789',
13    phone_number: '(555) 123-4567',
14    email: 'jane.doe@example.com',
15  },
16};
17const request: AssetReportCreateRequest = {
18  access_tokens: [accessToken],
19  days_requested,
20  options,
21};
22// accessTokens is an array of Item access tokens.
23// Note that the assets product must be enabled for all Items.
24// All fields on the options object are optional.
25try {
26  const response = await plaidClient.assetReportCreate(request);
27  const assetReportId = response.data.asset_report_id;
28  const assetReportToken = response.data.asset_report_token;
29} catch (error) {
30  // handle error
31}

Sample response data is below.

Assets response: create
1{
2  "asset_report_token": "assets-sandbox-6f12f5bb-22dd-4855-b918-f47ec439198a",
3  "asset_report_id": "1f414183-220c-44f5-b0c8-bc0e6d4053bb",
4  "request_id": "Iam3b"
5}

Fetching asset data

Once an Asset Report has been created, it can be retrieved to analyze the user's loan eligibility. For more detailed information on the schema for Asset Reports, see /asset_report/get.

Asset Reports are not generated instantly. If you receive a PRODUCT_NOT_READY error when calling /asset_report/get, the requested Asset Report has not yet been generated. To be alerted when the requested Asset Report has been generated, listen to Assets webhooks.

Assets sample request: get

Select group for content switcher

 
Select Language
1const { AssetReportGetRequest } = require('plaid');
2
3const request: AssetReportGetRequest = {
4  asset_report_token: assetReportToken,
5  include_insights: true,
6};
7try {
8  const response = await plaidClient.assetReportGet(request);
9  const assetReportId = response.data.asset_report_id;
10} catch (error) {
11  // handle error
12}

Sample response data is below.

Assets response: get
1{
"report": {
  "asset_report_id": "bf3a0490-344c-4620-a219-2693162e4b1d",
  "client_report_id": "123abc",
  "date_generated": "2020-06-05T22:47:53Z",
  "days_requested": 2,
  "items": [
    {
      "accounts": [
        {
          "account_id": "3gE5gnRzNyfXpBK5wEEKcymJ5albGVUqg77gr",
          "balances": {
            "available": 200,
            "current": 210,
            "iso_currency_code": "USD",
            "limit": null,
            "unofficial_currency_code": null
          },
          "days_available": 2,
          "historical_balances": [
            {
              "current": 210,
              "date": "2020-06-04",
              "iso_currency_code": "USD",
              "unofficial_currency_code": null
            },
            {
              "current": 210,
              "date": "2020-06-03",
              "iso_currency_code": "USD",
              "unofficial_currency_code": null
            }
          ],
          "mask": "1111",
          "name": "Plaid Saving",
          "official_name": "Plaid Silver Standard 0.1% Interest Saving",
          "owners": [
            {
              "addresses": [
                {
                  "data": {
                    "city": "Malakoff",
                    "country": "US",
                    "postal_code": "14236",
                    "region": "NY",
                    "street": "2992 Cameron Road"
                  },
                  "primary": true
                },
                {
                  "data": {
                    "city": "San Matias",
                    "country": "US",
                    "postal_code": "93405-2255",
                    "region": "CA",
                    "street": "2493 Leisure Lane"
                  },
                  "primary": false
                }
              ],
              "emails": [
                {
                  "data": "accountholder0@example.com",
                  "primary": true,
                  "type": "primary"
                },
                {
                  "data": "extraordinarily.long.email.username.123456@reallylonghostname.com",
                  "primary": false,
                  "type": "other"
                }
              ],
              "names": ["Alberta Bobbeth Charleson"],
              "phone_numbers": [
                {
                  "data": "1112223333",
                  "primary": false,
                  "type": "home"
                },
                {
                  "data": "1112225555",
                  "primary": false,
                  "type": "mobile1"
                }
              ]
            }
          ],
          "ownership_type": null,
          "subtype": "savings",
          "transactions": [],
          "type": "depository"
        },
        {
          "account_id": "BxBXxLj1m4HMXBm9WZJyUg9XLd4rKEhw8Pb1J",
          "balances": {
            "available": null,
            "current": 56302.06,
            "iso_currency_code": "USD",
            "limit": null,
            "unofficial_currency_code": null
          },
          "days_available": 2,
          "historical_balances": [],
          "mask": "8888",
          "name": "Plaid Mortgage",
          "official_name": null,
          "owners": [
            {
              "addresses": [
                {
                  "data": {
                    "city": "Malakoff",
                    "country": "US",
                    "postal_code": "14236",
                    "region": "NY",
                    "street": "2992 Cameron Road"
                  },
                  "primary": true
                },
                {
                  "data": {
                    "city": "San Matias",
                    "country": "US",
                    "postal_code": "93405-2255",
                    "region": "CA",
                    "street": "2493 Leisure Lane"
                  },
                  "primary": false
                }
              ],
              "emails": [
                {
                  "data": "accountholder0@example.com",
                  "primary": true,
                  "type": "primary"
                },
                {
                  "data": "extraordinarily.long.email.username.123456@reallylonghostname.com",
                  "primary": false,
                  "type": "other"
                }
              ],
              "names": ["Alberta Bobbeth Charleson"],
              "phone_numbers": [
                {
                  "data": "1112223333",
                  "primary": false,
                  "type": "home"
                },
                {
                  "data": "1112225555",
                  "primary": false,
                  "type": "mobile1"
                }
              ]
            }
          ],
          "ownership_type": null,
          "subtype": "mortgage",
          "transactions": [],
          "type": "loan"
        },
        {
          "account_id": "dVzbVMLjrxTnLjX4G66XUp5GLklm4oiZy88yK",
          "balances": {
            "available": null,
            "current": 410,
            "iso_currency_code": "USD",
            "limit": null,
            "unofficial_currency_code": null
          },
          "days_available": 2,
          "historical_balances": [
            {
              "current": 410,
              "date": "2020-06-04",
              "iso_currency_code": "USD",
              "unofficial_currency_code": null
            },
            {
              "current": 410,
              "date": "2020-06-03",
              "iso_currency_code": "USD",
              "unofficial_currency_code": null
            }
          ],
          "mask": "3333",
          "name": "Plaid Credit Card",
          "official_name": "Plaid Diamond 12.5% APR Interest Credit Card",
          "owners": [
            {
              "addresses": [
                {
                  "data": {
                    "city": "Malakoff",
                    "country": "US",
                    "postal_code": "14236",
                    "region": "NY",
                    "street": "2992 Cameron Road"
                  },
                  "primary": true
                },
                {
                  "data": {
                    "city": "San Matias",
                    "country": "US",
                    "postal_code": "93405-2255",
                    "region": "CA",
                    "street": "2493 Leisure Lane"
                  },
                  "primary": false
                }
              ],
              "emails": [
                {
                  "data": "accountholder0@example.com",
                  "primary": true,
                  "type": "primary"
                },
                {
                  "data": "extraordinarily.long.email.username.123456@reallylonghostname.com",
                  "primary": false,
                  "type": "other"
                }
              ],
              "names": ["Alberta Bobbeth Charleson"],
              "phone_numbers": [
                {
                  "data": "1112223333",
                  "primary": false,
                  "type": "home"
                },
                {
                  "data": "1112225555",
                  "primary": false,
                  "type": "mobile1"
                }
              ]
            }
          ],
          "ownership_type": null,
          "subtype": "credit card",
          "transactions": [],
          "type": "credit"
        }
      ],
      "date_last_updated": "2020-06-05T22:47:52Z",
      "institution_id": "ins_3",
      "institution_name": "Chase",
      "item_id": "eVBnVMp7zdTJLkRNr33Rs6zr7KNJqBFL9DrE6"
    }
  ],
  "user": {
    "client_user_id": "123456789",
    "email": "accountholder0@example.com",
    "first_name": "Alberta",
    "last_name": "Charleson",
    "middle_name": "Bobbeth",
    "phone_number": "111-222-3333",
    "ssn": "123-45-6789"
  }
},
"request_id": "eYupqX1mZkEuQRx",
"warnings": []
265}

Create an Asset Report

Learn how to create Asset Reports with the Assets product

Get Plaid API keys and complete application and company profile

Install and initialize Plaid libraries

Create an Item in Link

Create a link_token

Install Link dependency

Configure the client-side Link handler

Get a persistent access_token

Creating Asset Reports

Assets sample request: create

Fetching asset data

Assets sample request: get

Working with Assets data

Next steps

Launch checklist