Introduction to Liabilities
Access data for credit cards, closed-end loans, and lines of credit
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 is supported in the US and Canada (Canada coverage is limited).
Integration process
Below is a high level overview of the Liabilities integration process. For a more detailed walkthrough, see Add Liabilities to your app.
If your use case involves seeing a user's full financial picture across multiple institutions, you can use Multi-Item Link to let users link multiple accounts in a single Link session.
- Create a Link token by calling
/link/token/createwithliabilitiesin theproductsarray.- If your use case involves a user linking Items at multiple institutions, consider using Multi-Item Link.
- Initialize Link with the Link token from the previous step. For more details, see Link.
- Once the user has successfully completed the Link flow, exchange the
public_tokenfor anaccess_tokenby calling/item/public_token/exchange. - Call
/liabilities/getwith theaccess_tokento retrieve Liabilities data for the Item. - Listen for the
DEFAULT_UPDATEwebhook to know when updated Liabilities data is available, then call/liabilities/getagain to retrieve it.
Liabilities data
With Liabilities, you can view account information for credit cards, PayPal credit accounts, closed-end loans (student, mortgage, auto, personal, home equity, and commercial loans), and lines of credit, including home equity and commercial lines of credit. 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.
Liability response fields by account subtype
Liability data for each supported account subtype is returned in the following array on the liabilities object:
| Account type | Account subtypes | /liabilities/get field |
|---|---|---|
credit | credit card, paypal | credit |
loan | mortgage | mortgage |
loan | student | student |
loan | auto, commercial, consumer, home equity loan, loan | loan |
loan | commercial line of credit, home equity, line of credit | line_of_credit |
Note that liabilities data does not contain detailed transaction history for credit card accounts. For credit card account transactions, use the Transactions product.
"credit": [
{
"account_id": "dVzbVMLjrxTnLjX4G66XUp5GLklm4oiZy88yK",
"aprs": [
{
"apr_percentage": 15.24,
"apr_type": "balance_transfer_apr",
"balance_subject_to_apr": 1562.32,
"interest_charge_amount": 130.22
},
{
"apr_percentage": 27.95,
"apr_type": "cash_apr",
"balance_subject_to_apr": 56.22,
"interest_charge_amount": 14.81
},
{
"apr_percentage": 12.5,
"apr_type": "purchase_apr",
"balance_subject_to_apr": 157.01,
"interest_charge_amount": 25.66
},
{
"apr_percentage": 0,
"apr_type": "special",
"balance_subject_to_apr": 1000,
"interest_charge_amount": 0
}
],
"is_overdue": false,
"last_payment_amount": 168.25,
"last_payment_date": "2019-05-22",
"last_statement_issue_date": "2019-05-28",
"last_statement_balance": 1708.77,
"minimum_payment_amount": 20,
"next_payment_due_date": "2020-05-28"
}
]"student": [
{
"account_id": "Pp1Vpkl9w8sajvK6oEEKtr7vZxBnGpf7LxxLE",
"account_number": "4277075694",
"disbursement_dates": [
"2002-08-28"
],
"expected_payoff_date": "2032-07-28",
"guarantor": "DEPT OF ED",
"interest_rate_percentage": 5.25,
"is_overdue": false,
"last_payment_amount": 138.05,
"last_payment_date": "2019-04-22",
"last_statement_issue_date": "2019-04-28",
"loan_name": "Consolidation",
"loan_status": {
"end_date": "2032-07-28",
"type": "repayment"
},
"minimum_payment_amount": 25,
"next_payment_due_date": "2019-05-28",
"origination_date": "2002-08-28",
"origination_principal_amount": 25000,
"outstanding_interest_amount": 6227.36,
"payment_reference_number": "4277075694",
"pslf_status": {
// No longer populated: this object remains part of the schema, but its fields are now returned as null.
"estimated_eligibility_date": null,
"payments_made": null,
"payments_remaining": null
},
"repayment_plan": {
"description": "Standard Repayment",
"type": "standard"
},
"sequence_number": "1",
"servicer_address": {
"city": "San Matias",
"country": "US",
"postal_code": "99415",
"region": "CA",
"street": "123 Relaxation Road"
},
"ytd_interest_paid": 280.55,
"ytd_principal_paid": 271.65
}
]"mortgage": [
{
"account_id": "BxBXxLj1m4HMXBm9WZJyUg9XLd4rKEhw8Pb1J",
"account_number": "3120194154",
"current_late_fee": 25.00,
"escrow_balance": 3141.54,
"has_pmi": true,
"has_prepayment_penalty": true,
"interest_rate": {
"percentage": 3.99,
"type": "fixed"
},
"last_payment_amount": 3141.54,
"last_payment_date": "2019-08-01",
"loan_term": "30 year",
"loan_type_description": "conventional",
"maturity_date": "2045-07-31",
"next_monthly_payment": 3141.54,
"next_payment_due_date": "2019-11-15",
"origination_date": "2015-08-01",
"origination_principal_amount": 425000,
"past_due_amount": 2304,
"property_address": {
"city": "Malakoff",
"country": "US",
"postal_code": "14236",
"region": "NY",
"street": "2992 Cameron Road"
},
"ytd_interest_paid": 12300.40,
"ytd_principal_paid": 12340.50
}
]"loan": [
{
"account_id": "c0cTGbrDXN3xiGLGUNI9LGwxrOGjakxtWTgQV",
"account_number": "8943210074",
"interest_rate": {
"percentage": 6.49,
"type": "fixed"
},
"principal_balance": 18250,
"origination_principal_amount": 32000,
"origination_date": "2023-09-01",
"loan_term_months": 72,
"maturity_date": "2029-09-01",
"payment_count": 72,
"payment_frequency": "monthly",
"next_payment_amount": 525.4,
"next_payment_due_date": "2026-07-01",
"last_payment_amount": 525.4,
"last_payment_date": "2026-06-01",
"payoff_amount": 18190.25,
"ytd_interest_paid": 612.18,
"compounding_period": "monthly"
}
]"line_of_credit": [
{
"account_id": "ufQuuYHpSjhuk9TKIQTnDWlFVDIR5nWSynuQD",
"interest_rate": {
"percentage": 8.25,
"type": "variable"
},
"credit_limit": 100000,
"available_credit": 76000,
"principal_balance": 24000,
"minimum_payment_amount": 180,
"next_payment_amount": 180,
"next_payment_due_date": "2026-07-05",
"last_payment_amount": 180,
"last_payment_date": "2026-06-05",
"last_statement_balance": 24000,
"last_statement_issue_date": "2026-06-01",
"past_due_amount": 0,
"finance_charges": 162.5,
"draw_period_end_date": "2032-03-10",
"aprs": [
{
"apr_percentage": 8.25,
"apr_type": "purchase_apr",
"balance_subject_to_apr": null,
"interest_charge_amount": null
}
]
}
]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 without any additional permissions.
To test general-purpose, commercial, and home-equity loans and lines of credit in Sandbox, see Liabilities testing credentials.
To test student loan accounts beyond those offered by the default Sandbox user, see Configuring the custom user account.
Liabilities pricing
Liabilities is billed on a subscription model. To view the exact pricing you may be eligible for, apply for Production access or contact sales. For more details about pricing and billing models, see Plaid billing.
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.