Introduction to Liabilities

Access data for student loans, mortgages, and credit cards using the Liabilities product.

Explore API

API Reference

View Liabilities requests, responses, and example code

View Liabilities API

Quickstart

Learn about Plaid's key concepts and run starter code

Get started

Overview

Plaid's Liabilities product allows you to access information about a user's debts. A common application is personal financial management tools to help customers manage or refinance debt.

Liabilities data

With Liabilities, you can view account information for credit cards, PayPal credit accounts, student loans, and mortgages in the US. Available information includes balance, next payment date and amount, loan terms such as duration and interest rate, and originator information such as the origination date and initial loan amount. Liabilities data is refreshed approximately once per day, and the latest data can be accessed by calling /liabilities/get.

Note that liabilities data does not contain detailed transaction history for credit card accounts. For credit card account transactions, use the Transactions product.

1"credit": [
2  {
3    "account_id": "dVzbVMLjrxTnLjX4G66XUp5GLklm4oiZy88yK",
4    "aprs": [
5      {
6        "apr_percentage": 15.24,
7        "apr_type": "balance_transfer_apr",
8        "balance_subject_to_apr": 1562.32,
9        "interest_charge_amount": 130.22
10      },
11      {
12        "apr_percentage": 27.95,
13        "apr_type": "cash_apr",
14        "balance_subject_to_apr": 56.22,
15        "interest_charge_amount": 14.81
16      },
17      {
18        "apr_percentage": 12.5,
19        "apr_type": "purchase_apr",
20        "balance_subject_to_apr": 157.01,
21        "interest_charge_amount": 25.66
22      },
23      {
24        "apr_percentage": 0,
25        "apr_type": "special",
26        "balance_subject_to_apr": 1000,
27        "interest_charge_amount": 0
28      }
29    ],
30    "is_overdue": false,
31    "last_payment_amount": 168.25,
32    "last_payment_date": "2019-05-22",
33    "last_statement_issue_date": "2019-05-28",
34    "last_statement_balance": 1708.77,
35    "minimum_payment_amount": 20,
36    "next_payment_due_date": "2020-05-28"
37  }
38]
1"student": [
2  {
3    "account_id": "Pp1Vpkl9w8sajvK6oEEKtr7vZxBnGpf7LxxLE",
4    "account_number": "4277075694",
5    "disbursement_dates": [
6      "2002-08-28"
7    ],
8    "expected_payoff_date": "2032-07-28",
9    "guarantor": "DEPT OF ED",
10    "interest_rate_percentage": 5.25,
11    "is_overdue": false,
12    "last_payment_amount": 138.05,
13    "last_payment_date": "2019-04-22",
14    "last_statement_issue_date": "2019-04-28",
15    "loan_name": "Consolidation",
16    "loan_status": {
17      "end_date": "2032-07-28",
18      "type": "repayment"
19    },
20    "minimum_payment_amount": 25,
21    "next_payment_due_date": "2019-05-28",
22    "origination_date": "2002-08-28",
23    "origination_principal_amount": 25000,
24    "outstanding_interest_amount": 6227.36,
25    "payment_reference_number": "4277075694",
26    "pslf_status": {
27      "estimated_eligibility_date": "2021-01-01",
28      "payments_made": 200,
29      "payments_remaining": 160
30    },
31    "repayment_plan": {
32      "description": "Standard Repayment",
33      "type": "standard"
34    },
35    "sequence_number": "1",
36    "servicer_address": {
37      "city": "San Matias",
38      "country": "US",
39      "postal_code": "99415",
40      "region": "CA",
41      "street": "123 Relaxation Road"
42    },
43    "ytd_interest_paid": 280.55,
44    "ytd_principal_paid": 271.65
45  }
46]
1"mortgage": [
2  {
3    "account_id": "BxBXxLj1m4HMXBm9WZJyUg9XLd4rKEhw8Pb1J",
4    "account_number": "3120194154",
5    "current_late_fee": 25.0,
6    "escrow_balance": 3141.54,
7    "has_pmi": true,
8    "has_prepayment_penalty": true,
9    "interest_rate": {
10      "percentage": 3.99,
11      "type": "fixed",
12    },
13    "last_payment_amount": 3141.54,
14    "last_payment_date": "2019-08-01",
15    "loan_term": "30 year",
16    "loan_type_description": "conventional",
17    "maturity_date": "2045-07-31",
18    "next_monthly_payment": 3141.54,
19    "next_payment_due_date": "2019-11-15",
20    "origination_date": "2015-08-01",
21    "origination_principal_amount": 425000,
22    "past_due_amount": 2304,
23    "property_address": {
24      "city": "Malakoff",
25      "country": "US",
26      "postal_code": "14236",
27      "region": "NY",
28      "street": "2992 Cameron Road",
29    }
30    "ytd_interest_paid": 12300.4,
31    "ytd_principal_paid": 12340.5
32  }
33]

Payment history

The information returned by a /liabilities/get request contains recent payment information, such as the date and amount of the most recent payment. To view further payment history, you can use Plaid's Transactions product.

Liabilities webhooks

Plaid checks for updated Liabilities data approximately once per day and uses webhooks to inform you of any changes so you can keep your app up to date. For more detail on how to listen and respond to these webhooks, see Liabilities webhooks.

Testing Liabilities

Liabilities can be tested in Sandbox or Development without any additional permissions.

Plaid also provides a GitHub repo with test data for testing student loan accounts in Sandbox. For more information on configuring custom Sandbox data, see Configuring the custom user account.

Next steps

To get started building with Liabilities, see Add Liabilities to your App.

If you're ready to launch to Production, see the Launch checklist.

Launch checklist

Recommended steps to take before launching in Production

Launch