Liabilities
API reference for Liabilities endpoints and webhooks
Endpoints | |
---|---|
/liabilities/get | Fetch liabilities data |
Webhooks | |
---|---|
DEFAULT_UPDATE | New or updated liabilities available |
Endpoints
/liabilities/get
Retrieve Liabilities data
The /liabilities/get
endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type credit
with account subtype credit card
or paypal
, and account type loan
with account subtype student
or mortgage
. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the account_filters
parameter when creating a Link token.
The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling /liabilities/get
.
client_id
client_id
. The client_id
is required and may be provided either in the PLAID-CLIENT-ID
header or as part of a request body.secret
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.access_token
options
/liabilities/get
results. If provided, options
cannot be null.account_ids
An error will be returned if a provided
account_id
is not associated with the Item1// Retrieve Liabilities data for an Item2const request: LiabilitiesGetRequest = {3 access_token: accessToken,4};5try {6 const response = await plaidClient.liabilitiesGet(request);7 const liabilities = response.data.liabilities;8} catch (error) {9 // handle error10}
Response fields and example
accounts
account_id
account_id
will be assigned to the account.The
account_id
can also change if the access_token
is deleted and the same credentials that were used to generate that access_token
are used to generate a new access_token
on a later date. In that case, the new account_id
will be different from the old account_id
.If an account with a specific
account_id
disappears instead of changing, the account is likely closed. Closed accounts are not returned by the Plaid API.Like all Plaid identifiers, the
account_id
is case sensitive.balances
/accounts/balance/get
.available
For
credit
-type accounts, the available
balance typically equals the limit
less the current
balance, less any pending outflows plus any pending inflows.For
depository
-type accounts, the available
balance typically equals the current
balance less any pending outflows plus any pending inflows. For depository
-type accounts, the available
balance does not include the overdraft limit.For
investment
-type accounts (or brokerage
-type accounts for API versions 2018-05-22 and earlier), the available
balance is the total cash available to withdraw as presented by the institution.Note that not all institutions calculate the
available
balance. In the event that available
balance is unavailable, Plaid will return an available
balance value of null
.Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by
/accounts/balance/get
.If
current
is null
this field is guaranteed not to be null
.double
current
For
credit
-type accounts, a positive balance indicates the amount owed; a negative amount indicates the lender owing the account holder.For
loan
-type accounts, the current balance is the principal remaining on the loan, except in the case of student loan accounts at Sallie Mae (ins_116944
). For Sallie Mae student loans, the account's balance includes both principal and any outstanding interest.For
investment
-type accounts (or brokerage
-type accounts for API versions 2018-05-22 and earlier), the current balance is the total value of assets as presented by the institution.Note that balance information may be cached unless the value was returned by
/accounts/balance/get
; if the Item is enabled for Transactions, the balance will be at least as recent as the most recent Transaction update. If you require realtime balance information, use the available
balance as provided by /accounts/balance/get
.When returned by
/accounts/balance/get
, this field may be null
. When this happens, available
is guaranteed not to be null
.double
limit
credit
-type accounts, this represents the credit limit.For
depository
-type accounts, this represents the pre-arranged overdraft limit, which is common for current (checking) accounts in Europe.In North America, this field is typically only available for
credit
-type accounts.double
iso_currency_code
unofficial_currency_code
is non-null.unofficial_currency _code
iso_currency_code
is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.See the currency code schema for a full listing of supported
unofficial_currency_code
s.last_updated_datetime
YYYY-MM-DDTHH:mm:ssZ
) indicating the oldest acceptable balance when making a request to /accounts/balance/get
.This field is only used and expected when the institution is
ins_128026
(Capital One) and the Item contains one or more accounts with a non-depository account type, in which case a value must be provided or an INVALID_REQUEST
error with the code of INVALID_FIELD
will be returned. For Capital One depository accounts as well as all other account types on all other institutions, this field is ignored. See account type schema for a full list of account types.If the balance that is pulled is older than the given timestamp for Items with this field required, an
INVALID_REQUEST
error with the code of LAST_UPDATED_DATETIME_OUT_OF_RANGE
will be returned with the most recent timestamp for the requested account contained in the response.date-time
mask
name
official_name
type
investment:
Investment account. In API versions 2018-05-22 and earlier, this type is called brokerage
instead.credit:
Credit carddepository:
Depository accountloan:
Loan accountother:
Non-specified account typeSee the Account type schema for a full listing of account types and corresponding subtypes.
investment
, credit
, depository
, loan
, brokerage
, other
subtype
401a
, 401k
, 403B
, 457b
, 529
, auto
, brokerage
, business
, cash isa
, cash management
, cd
, checking
, commercial
, construction
, consumer
, credit card
, crypto exchange
, ebt
, education savings account
, fixed annuity
, gic
, health reimbursement arrangement
, home equity
, hsa
, isa
, ira
, keogh
, lif
, life insurance
, line of credit
, lira
, loan
, lrif
, lrsp
, money market
, mortgage
, mutual fund
, non-custodial wallet
, non-taxable brokerage account
, other
, other insurance
, other annuity
, overdraft
, paypal
, payroll
, pension
, prepaid
, prif
, profit sharing plan
, rdsp
, resp
, retirement
, rlif
, roth
, roth 401k
, rrif
, rrsp
, sarsep
, savings
, sep ira
, simple ira
, sipp
, stock plan
, student
, thrift savings plan
, tfsa
, trust
, ugma
, utma
, variable annuity
verification_status
pending_automatic_verification
: The Item is pending automatic verificationpending_manual_verification
: The Item is pending manual micro-deposit verification. Items remain in this state until the user successfully verifies the micro-deposit.automatically_verified
: The Item has successfully been automatically verified manually_verified
: The Item has successfully been manually verifiedverification_expired
: Plaid was unable to automatically verify the deposit within 7 calendar days and will no longer attempt to validate the Item. Users may retry by submitting their information again through Link.verification_failed
: The Item failed manual micro-deposit verification because the user exhausted all 3 verification attempts. Users may retry by submitting their information again through Link.database_matched
: The Item has successfully been verified using Plaid's data sources. Only returned for Auth Items created via Database Match.database_insights_pass
: The Item's numbers have been verified using Plaid's data sources and have strong signal for being valid. Only returned for Auth Items created via Database Insights. Note: Database Insights is currently a beta feature, please contact your account manager for more information.database_insights_pass_with_caution
: The Item's numbers have been verified using Plaid's data sources and have some signal for being valid. Only returned for Auth Items created via Database Insights. Note: Database Insights is currently a beta feature, please contact your account manager for more information.database_insights_fail
: The Item's numbers have been verified using Plaid's data sources and have signal for being invalid and/or have no signal for being valid. Only returned for Auth Items created via Database Insights. Note: Database Insights is currently a beta feature, please contact your account manager for more information.automatically_verified
, pending_automatic_verification
, pending_manual_verification
, manually_verified
, verification_expired
, verification_failed
, database_matched
, database_insights_pass
, database_insights_pass_with_caution
, database_insights_fail
verification_insights
network_status
has_numbers_match
is_numbers_match _verified
previous_returns
has_previous _administrative_return
account_number_format
valid
: indicates that the account number has a correct format for the institution.invalid
: indicates that the account number has an incorrect format for the institution.unknown
: indicates that there was not enough information to determine whether the format is correct for the institution.valid
, invalid
, unknown
persistent_account_id
holder_category
business
, personal
, unrecognized
item
item_id
item_id
is always unique; linking the same account at the same institution twice will result in two Items with different item_id
values. Like all Plaid identifiers, the item_id
is case-sensitive.institution_id
null
for Items created without an institution connection, such as Items created via Same Day Micro-deposits.institution_name
null
for Items created without an institution connection, such as Items created via Same Day Micro-deposits.webhook
error
error_code
and categorized by error_type
. Use these in preference to HTTP status codes to identify and handle specific errors. HTTP status codes are set and provide the broadest categorization of errors: 4xx codes are for developer- or user-related errors, and 5xx codes are for Plaid-related errors, and the status will be 2xx in non-error cases. An Item with a non-null
error object will only be part of an API response when calling /item/get
to view Item status. Otherwise, error fields will be null
if no error has occurred; if an error has occurred, an error code will be returned instead.error_type
INVALID_REQUEST
, INVALID_RESULT
, INVALID_INPUT
, INSTITUTION_ERROR
, RATE_LIMIT_EXCEEDED
, API_ERROR
, ITEM_ERROR
, ASSET_REPORT_ERROR
, RECAPTCHA_ERROR
, OAUTH_ERROR
, PAYMENT_ERROR
, BANK_TRANSFER_ERROR
, INCOME_VERIFICATION_ERROR
, MICRODEPOSITS_ERROR
, SANDBOX_ERROR
, PARTNER_ERROR
, TRANSACTIONS_ERROR
, TRANSACTION_ERROR
, TRANSFER_ERROR
error_code
error_code_reason
null
will be returned otherwise. Safe for programmatic use.Possible values:
OAUTH_INVALID_TOKEN
: The user’s OAuth connection to this institution has been invalidated.OAUTH_CONSENT_EXPIRED
: The user's access consent for this OAuth connection to this institution has expired.OAUTH_REVOKED_TOKEN
: The user’s OAuth connection to this institution is invalid because the user revoked their connection.error_message
display_message
null
if the error is not related to user action.This may change over time and is not safe for programmatic use.
request_id
causes
causes
will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified.causes
will only be provided for the error_type
ASSET_REPORT_ERROR
. causes
will also not be populated inside an error nested within a warning
object.status
documentation_url
suggested_action
available_products
billed_products
.assets
, auth
, balance
, balance_plus
, beacon
, identity
, identity_match
, investments
, investments_auth
, liabilities
, payment_initiation
, identity_verification
, transactions
, credit_details
, income
, income_verification
, standing_orders
, transfer
, employment
, recurring_transactions
, signal
, statements
, processor_payments
, processor_identity
, profile
, cra_base_report
, cra_income_insights
, cra_partner_insights
, cra_network_insights
, cra_cashflow_insights
, layer
, pay_by_bank
billed_products
available_products
. Note - billed_products
is populated in all environments but only requests in Production are billed. Also note that products that are billed on a pay-per-call basis rather than a pay-per-Item basis, such as balance
, will not appear here.assets
, auth
, balance
, balance_plus
, beacon
, identity
, identity_match
, investments
, investments_auth
, liabilities
, payment_initiation
, identity_verification
, transactions
, credit_details
, income
, income_verification
, standing_orders
, transfer
, employment
, recurring_transactions
, signal
, statements
, processor_payments
, processor_identity
, profile
, cra_base_report
, cra_income_insights
, cra_partner_insights
, cra_network_insights
, cra_cashflow_insights
, layer
, pay_by_bank
products
billed_products
field. For some products, it is possible for the product to be added to an Item but not yet billed (e.g. Assets, before /asset_report/create
has been called, or Auth or Identity when added as Optional Products but before their endpoints have been called), in which case the product may appear in products
but not in billed_products
.assets
, auth
, balance
, balance_plus
, beacon
, identity
, identity_match
, investments
, investments_auth
, liabilities
, payment_initiation
, identity_verification
, transactions
, credit_details
, income
, income_verification
, standing_orders
, transfer
, employment
, recurring_transactions
, signal
, statements
, processor_payments
, processor_identity
, profile
, cra_base_report
, cra_income_insights
, cra_partner_insights
, cra_network_insights
, cra_cashflow_insights
, layer
, pay_by_bank
consented_products
assets
, auth
, balance
, balance_plus
, beacon
, identity
, identity_match
, investments
, investments_auth
, liabilities
, transactions
, income
, income_verification
, transfer
, employment
, recurring_transactions
, signal
, statements
, processor_payments
, processor_identity
, cra_base_report
, cra_income_insights
, cra_partner_insights
, cra_cashflow_insights
, layer
consent_expiration _time
date-time
update_type
background
- Item can be updated in the backgrounduser_present_required
- Item requires user interaction to be updatedbackground
, user_present_required
liabilities
credit
account_id
aprs
apr_percentage
double
apr_type
balance_transfer_apr
, cash_apr
, purchase_apr
, special
balance_subject_to_apr
double
interest_charge_amount
double
is_overdue
last_payment_amount
double
last_payment_date
date
last_statement_issue _date
last_statement_balance
double
minimum_payment_amount
double
next_payment_due_date
null
if a payment is not expected. Dates are returned in an ISO 8601 format (YYYY-MM-DD).date
mortgage
account_id
account_number
current_late_fee
double
escrow_balance
double
has_pmi
has_prepayment_penalty
interest_rate
percentage
double
type
last_payment_amount
double
last_payment_date
loan_type_description
conventional
, fixed
, or variable
. This field is provided directly from the loan servicer and does not have an enumerated set of possible values.loan_term
10 year
).maturity_date
date
next_monthly_payment
double
next_payment_due_date
date
origination_date
date
origination_principal _amount
double
past_due_amount
double
property_address
city
country
postal_code
region
street
ytd_interest_paid
double
ytd_principal_paid
double
student
account_id
account_number
disbursement_dates
date
expected_payoff_date
date
guarantor
interest_rate _percentage
double
is_overdue
true
if a payment is currently overdue. Availability for this field is limited.last_payment_amount
double
last_payment_date
last_statement_balance
double
last_statement_issue _date
loan_name
loan_status
type
cancelled
, charged off
, claim
, consolidated
, deferment
, delinquent
, discharged
, extension
, forbearance
, in grace
, in military
, in school
, not fully disbursed
, other
, paid in full
, refunded
, repayment
, transferred
, pending idr
minimum_payment_amount
ins_116861
), Firstmark (ins_116295
), Commonbond Firstmark Services (ins_116950
), Granite State (ins_116308
), and Oklahoma Student Loan Authority (ins_116945
).
Firstmark (ins_116295
) and Navient (ins_116248
) will display as $0 if there is an autopay program in effect.double
next_payment_due_date
null
if a payment is not expected. A payment is not expected if loan_status.type
is deferment
, in_school
, consolidated
, paid in full
, or transferred
. Dates are returned in an ISO 8601 format (YYYY-MM-DD).date
origination_date
date
origination_principal _amount
double
outstanding_interest _amount
ins_116944
), this amount is included in the current balance of the loan, so this field will return as null
.double
payment_reference _number
payment_reference_number
will match account_number,
but in some institutions, such as Great Lakes (ins_116861
), it will be different.repayment_plan
description
type
extended graduated
, extended standard
, graduated
, income-contingent repayment
, income-based repayment
, income-sensitive repayment
, interest-only
, other
, pay as you earn
, revised pay as you earn
, standard
, saving on a valuable education
, null
sequence_number
ins_116948
) does not make this field available.servicer_address
city
region
"NC"
street
"564 Main Street, APT 15"
postal_code
country
ytd_interest_paid
double
ytd_principal_paid
double
request_id
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": null11 },12 "mask": "0000",13 "name": "Plaid Checking",14 "official_name": "Plaid Gold Standard 0% Interest Checking",15 "subtype": "checking",16 "type": "depository"17 },18 {19 "account_id": "dVzbVMLjrxTnLjX4G66XUp5GLklm4oiZy88yK",20 "balances": {21 "available": null,22 "current": 410,23 "iso_currency_code": "USD",24 "limit": 2000,25 "unofficial_currency_code": null26 },27 "mask": "3333",28 "name": "Plaid Credit Card",29 "official_name": "Plaid Diamond 12.5% APR Interest Credit Card",30 "subtype": "credit card",31 "type": "credit"32 },33 {34 "account_id": "Pp1Vpkl9w8sajvK6oEEKtr7vZxBnGpf7LxxLE",35 "balances": {36 "available": null,37 "current": 65262,38 "iso_currency_code": "USD",39 "limit": null,40 "unofficial_currency_code": null41 },42 "mask": "7777",43 "name": "Plaid Student Loan",44 "official_name": null,45 "subtype": "student",46 "type": "loan"47 },48 {49 "account_id": "BxBXxLj1m4HMXBm9WZJyUg9XLd4rKEhw8Pb1J",50 "balances": {51 "available": null,52 "current": 56302.06,53 "iso_currency_code": "USD",54 "limit": null,55 "unofficial_currency_code": null56 },57 "mask": "8888",58 "name": "Plaid Mortgage",59 "official_name": null,60 "subtype": "mortgage",61 "type": "loan"62 }63 ],64 "item": {65 "available_products": [66 "balance",67 "investments"68 ],69 "billed_products": [70 "assets",71 "auth",72 "identity",73 "liabilities",74 "transactions"75 ],76 "consent_expiration_time": null,77 "error": null,78 "institution_id": "ins_3",79 "institution_name": "Chase",80 "item_id": "eVBnVMp7zdTJLkRNr33Rs6zr7KNJqBFL9DrE6",81 "update_type": "background",82 "webhook": "https://www.genericwebhookurl.com/webhook"83 },84 "liabilities": {85 "credit": [86 {87 "account_id": "dVzbVMLjrxTnLjX4G66XUp5GLklm4oiZy88yK",88 "aprs": [89 {90 "apr_percentage": 15.24,91 "apr_type": "balance_transfer_apr",92 "balance_subject_to_apr": 1562.32,93 "interest_charge_amount": 130.2294 },95 {96 "apr_percentage": 27.95,97 "apr_type": "cash_apr",98 "balance_subject_to_apr": 56.22,99 "interest_charge_amount": 14.81100 },101 {102 "apr_percentage": 12.5,103 "apr_type": "purchase_apr",104 "balance_subject_to_apr": 157.01,105 "interest_charge_amount": 25.66106 },107 {108 "apr_percentage": 0,109 "apr_type": "special",110 "balance_subject_to_apr": 1000,111 "interest_charge_amount": 0112 }113 ],114 "is_overdue": false,115 "last_payment_amount": 168.25,116 "last_payment_date": "2019-05-22",117 "last_statement_issue_date": "2019-05-28",118 "last_statement_balance": 1708.77,119 "minimum_payment_amount": 20,120 "next_payment_due_date": "2020-05-28"121 }122 ],123 "mortgage": [124 {125 "account_id": "BxBXxLj1m4HMXBm9WZJyUg9XLd4rKEhw8Pb1J",126 "account_number": "3120194154",127 "current_late_fee": 25,128 "escrow_balance": 3141.54,129 "has_pmi": true,130 "has_prepayment_penalty": true,131 "interest_rate": {132 "percentage": 3.99,133 "type": "fixed"134 },135 "last_payment_amount": 3141.54,136 "last_payment_date": "2019-08-01",137 "loan_term": "30 year",138 "loan_type_description": "conventional",139 "maturity_date": "2045-07-31",140 "next_monthly_payment": 3141.54,141 "next_payment_due_date": "2019-11-15",142 "origination_date": "2015-08-01",143 "origination_principal_amount": 425000,144 "past_due_amount": 2304,145 "property_address": {146 "city": "Malakoff",147 "country": "US",148 "postal_code": "14236",149 "region": "NY",150 "street": "2992 Cameron Road"151 },152 "ytd_interest_paid": 12300.4,153 "ytd_principal_paid": 12340.5154 }155 ],156 "student": [157 {158 "account_id": "Pp1Vpkl9w8sajvK6oEEKtr7vZxBnGpf7LxxLE",159 "account_number": "4277075694",160 "disbursement_dates": [161 "2002-08-28"162 ],163 "expected_payoff_date": "2032-07-28",164 "guarantor": "DEPT OF ED",165 "interest_rate_percentage": 5.25,166 "is_overdue": false,167 "last_payment_amount": 138.05,168 "last_payment_date": "2019-04-22",169 "last_statement_issue_date": "2019-04-28",170 "last_statement_balance": 1708.77,171 "loan_name": "Consolidation",172 "loan_status": {173 "end_date": "2032-07-28",174 "type": "repayment"175 },176 "minimum_payment_amount": 25,177 "next_payment_due_date": "2019-05-28",178 "origination_date": "2002-08-28",179 "origination_principal_amount": 25000,180 "outstanding_interest_amount": 6227.36,181 "payment_reference_number": "4277075694",182 "pslf_status": {183 "estimated_eligibility_date": "2021-01-01",184 "payments_made": 200,185 "payments_remaining": 160186 },187 "repayment_plan": {188 "description": "Standard Repayment",189 "type": "standard"190 },191 "sequence_number": "1",192 "servicer_address": {193 "city": "San Matias",194 "country": "US",195 "postal_code": "99415",196 "region": "CA",197 "street": "123 Relaxation Road"198 },199 "ytd_interest_paid": 280.55,200 "ytd_principal_paid": 271.65201 }202 ]203 },204 "request_id": "dTnnm60WgKGLnKL"205}
Was this helpful?
Webhooks
Liabilities webhooks are sent to indicate that new loans or updated loan fields for existing accounts are available.
DEFAULT_UPDATE
The webhook of type LIABILITIES
and code DEFAULT_UPDATE
will be fired when new or updated liabilities have been detected on a liabilities item.
webhook_type
LIABILITIES
webhook_code
DEFAULT_UPDATE
item_id
item_id
of the Item associated with this webhook, warning, or errorerror
error_code
and categorized by error_type
. Use these in preference to HTTP status codes to identify and handle specific errors. HTTP status codes are set and provide the broadest categorization of errors: 4xx codes are for developer- or user-related errors, and 5xx codes are for Plaid-related errors, and the status will be 2xx in non-error cases. An Item with a non-null
error object will only be part of an API response when calling /item/get
to view Item status. Otherwise, error fields will be null
if no error has occurred; if an error has occurred, an error code will be returned instead.error_type
INVALID_REQUEST
, INVALID_RESULT
, INVALID_INPUT
, INSTITUTION_ERROR
, RATE_LIMIT_EXCEEDED
, API_ERROR
, ITEM_ERROR
, ASSET_REPORT_ERROR
, RECAPTCHA_ERROR
, OAUTH_ERROR
, PAYMENT_ERROR
, BANK_TRANSFER_ERROR
, INCOME_VERIFICATION_ERROR
, MICRODEPOSITS_ERROR
, SANDBOX_ERROR
, PARTNER_ERROR
, TRANSACTIONS_ERROR
, TRANSACTION_ERROR
, TRANSFER_ERROR
error_code
error_code_reason
null
will be returned otherwise. Safe for programmatic use.Possible values:
OAUTH_INVALID_TOKEN
: The user’s OAuth connection to this institution has been invalidated.OAUTH_CONSENT_EXPIRED
: The user's access consent for this OAuth connection to this institution has expired.OAUTH_REVOKED_TOKEN
: The user’s OAuth connection to this institution is invalid because the user revoked their connection.error_message
display_message
null
if the error is not related to user action.This may change over time and is not safe for programmatic use.
request_id
causes
causes
will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified.causes
will only be provided for the error_type
ASSET_REPORT_ERROR
. causes
will also not be populated inside an error nested within a warning
object.status
documentation_url
suggested_action
account_ids_with_new _liabilities
account_id
's for accounts that contain new liabilities.'account_ids_with _updated_liabilities
account_id
's that are mapped to their respective liabilities fields that changed.Example:
{ "XMBvvyMGQ1UoLbKByoMqH3nXMj84ALSdE5B58": ["past_amount_due"] }
environment
sandbox
, production
1{2 "webhook_type": "LIABILITIES",3 "webhook_code": "DEFAULT_UPDATE",4 "item_id": "wz666MBjYWTp2PDzzggYhM6oWWmBb",5 "error": null,6 "account_ids_with_new_liabilities": [7 "XMBvvyMGQ1UoLbKByoMqH3nXMj84ALSdE5B58",8 "BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp"9 ],10 "account_ids_with_updated_liabilities": {11 "XMBvvyMGQ1UoLbKByoMqH3nXMj84ALSdE5B58": [12 "past_amount_due"13 ]14 },15 "environment": "production"16}