Liabilities

API reference for Liabilities endpoints and webhooks

Endpoints
/liabilities/getFetch liabilities data
Webhooks
DEFAULT_UPDATENew 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.

liabilities/get
Request fields
client_id
string
Your Plaid API 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
string
Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.
access_token
requiredstring
The access token associated with the Item data is being requested for.
options
object
An optional object to filter /liabilities/get results. If provided, options cannot be null.
account_ids
[string]
A list of accounts to retrieve for the Item.
An error will be returned if a provided account_id is not associated with the Item
Select group for content switcher
1// Retrieve Liabilities data for an Item
2const 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 error
10}
liabilities/get

Response fields and example

accounts
[object]
An array of accounts associated with the Item
account_id
string
Plaid’s unique identifier for the account. This value will not change unless Plaid can't reconcile the account with the data returned by the financial institution. This may occur, for example, when the name of the account changes. If this happens a new 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
object
A set of fields describing the balance for an account. Balance information may be cached unless the balance object was returned by /accounts/balance/get.
available
nullablenumber
The amount of funds available to be withdrawn from the account, as determined by the financial institution.
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.

Format: double
current
nullablenumber
The total amount of funds in or owed by the account.
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.

Format: double
limit
nullablenumber
For 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.

Format: double
iso_currency_code
nullablestring
The ISO-4217 currency code of the balance. Always null if unofficial_currency_code is non-null.
unofficial_currency_code
nullablestring
The unofficial currency code associated with the balance. Always null if 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_codes.
last_updated_datetime
nullablestring
Timestamp in ISO 8601 format (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.

Format: date-time
mask
nullablestring
The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user.
name
string
The name of the account, either assigned by the user or by the financial institution itself
official_name
nullablestring
The official name of the account as given by the financial institution
type
string
investment: Investment account. In API versions 2018-05-22 and earlier, this type is called brokerage instead.
credit: Credit card
depository: Depository account
loan: Loan account
other: Non-specified account type
See the Account type schema for a full listing of account types and corresponding subtypes.

Possible values: investment, credit, depository, loan, brokerage, other
subtype
nullablestring
See the Account type schema for a full listing of account types and corresponding subtypes.

Possible values: 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
string
The current verification status of an Auth Item initiated through micro-deposits or database verification. Returned for Auth Items only.
pending_automatic_verification: The Item is pending automatic verification
pending_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 verified
verification_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.

Possible values: 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
object
Insights from performing database verification for the account. Only returned for Auth Items created via Database Insights.
network_status
object
Status information about the account and routing number in the Plaid network.
has_numbers_match
boolean
Indicates whether we found at least one matching account for the ACH account and routing number.
is_numbers_match_verified
boolean
Indicates if at least one matching account for the ACH account and routing number is already verified.
previous_returns
object
Information about known ACH returns for the account and routing number.
has_previous_administrative_return
boolean
Indicates whether Plaid's data sources include a known administrative ACH return for account and routing number.
account_number_format
string
Indicator of account number format validity for institution.
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.

Possible values: valid, invalid, unknown
persistent_account_id
string
A unique and persistent identifier for accounts that can be used to trace multiple instances of the same account across different Items for depository accounts. This field is currently supported only for Items at institutions that use Tokenized Account Numbers (i.e., Chase and PNC). Because these accounts have a different account number each time they are linked, this field may be used instead of the account number to uniquely identify an account across multiple Items for payments use cases, helping to reduce duplicate Items or attempted fraud. In Sandbox, this field may be populated for any account; in Production, it will only be populated for accounts at applicable institutions.
holder_category
nullablestring
Indicates the account's categorization as either a personal or a business account. This field is currently in beta; to request access, contact your account manager.

Possible values: business, personal, unrecognized
item
object
Metadata about the Item.
item_id
string
The Plaid Item ID. The 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
nullablestring
The Plaid Institution ID associated with the Item. Field is null for Items created via Same Day Micro-deposits.
webhook
nullablestring
The URL registered to receive webhooks for the Item.
error
nullableobject
Errors are identified by 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
string
A broad categorization of the error. Safe for programmatic use.

Possible values: 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
string
The particular error code. Safe for programmatic use.
error_code_reason
nullablestring
The specific reason for the error code. Currently, reasons are only supported OAuth-based item errors; 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
string
A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.
display_message
nullablestring
A user-friendly representation of the error code. null if the error is not related to user action.
This may change over time and is not safe for programmatic use.
request_id
string
A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.
causes
array
In this product, a request can pertain to more than one Item. If an error is returned for such a request, 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
nullableinteger
The HTTP status code associated with the error. This will only be returned in the response body when the error information is provided via a webhook.
documentation_url
string
The URL of a Plaid documentation page with more information about the error
suggested_action
nullablestring
Suggested steps for resolving the error
available_products
[string]
A list of products available for the Item that have not yet been accessed. The contents of this array will be mutually exclusive with billed_products.

Possible values: 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
[string]
A list of products that have been billed for the Item. The contents of this array will be mutually exclusive with 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.

Possible values: 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
[string]
A list of products added to the Item. In almost all cases, this will be the same as the 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.

Possible values: 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
[string]
A list of products that the user has consented to for the Item via Data Transparency Messaging. This will consist of all products where both of the following are true: the user has consented to the required data scopes for that product and you have Production access for that product.

Possible values: 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
nullablestring
The date and time at which the Item's access consent will expire, in ISO 8601 format

Format: date-time
update_type
string
Indicates whether an Item requires user interaction to be updated, which can be the case for Items with some forms of two-factor authentication.
background - Item can be updated in the background
user_present_required - Item requires user interaction to be updated

Possible values: background, user_present_required
liabilities
object
An object containing liability accounts
credit
nullable[object]
The credit accounts returned.
account_id
nullablestring
The ID of the account that this liability belongs to.
aprs
[object]
The various interest rates that apply to the account. APR information is not provided by all card issuers; if APR data is not available, this array will be empty.
apr_percentage
number
Annual Percentage Rate applied.

Format: double
apr_type
string
The type of balance to which the APR applies.

Possible values: balance_transfer_apr, cash_apr, purchase_apr, special
balance_subject_to_apr
nullablenumber
Amount of money that is subjected to the APR if a balance was carried beyond payment due date. How it is calculated can vary by card issuer. It is often calculated as an average daily balance.

Format: double
interest_charge_amount
nullablenumber
Amount of money charged due to interest from last statement.

Format: double
is_overdue
nullableboolean
true if a payment is currently overdue. Availability for this field is limited.
last_payment_amount
nullablenumber
The amount of the last payment.

Format: double
last_payment_date
nullablestring
The date of the last payment. Dates are returned in an ISO 8601 format (YYYY-MM-DD). Availability for this field is limited.

Format: date
last_statement_issue_date
nullablestring
The date of the last statement. Dates are returned in an ISO 8601 format (YYYY-MM-DD).

Format: date
last_statement_balance
nullablenumber
The total amount owed as of the last statement issued

Format: double
minimum_payment_amount
nullablenumber
The minimum payment due for the next billing cycle.

Format: double
next_payment_due_date
nullablestring
The due date for the next payment. The due date is null if a payment is not expected. Dates are returned in an ISO 8601 format (YYYY-MM-DD).

Format: date
mortgage
nullable[object]
The mortgage accounts returned.
account_id
string
The ID of the account that this liability belongs to.
account_number
string
The account number of the loan.
current_late_fee
nullablenumber
The current outstanding amount charged for late payment.

Format: double
escrow_balance
nullablenumber
Total amount held in escrow to pay taxes and insurance on behalf of the borrower.

Format: double
has_pmi
nullableboolean
Indicates whether the borrower has private mortgage insurance in effect.
has_prepayment_penalty
nullableboolean
Indicates whether the borrower will pay a penalty for early payoff of mortgage.
interest_rate
object
Object containing metadata about the interest rate for the mortgage.
percentage
nullablenumber
Percentage value (interest rate of current mortgage, not APR) of interest payable on a loan.

Format: double
type
nullablestring
The type of interest charged (fixed or variable).
last_payment_amount
nullablenumber
The amount of the last payment.

Format: double
last_payment_date
nullablestring
The date of the last payment. Dates are returned in an ISO 8601 format (YYYY-MM-DD).

Format: date
loan_type_description
nullablestring
Description of the type of loan, for example 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
nullablestring
Full duration of mortgage as at origination (e.g. 10 year).
maturity_date
nullablestring
Original date on which mortgage is due in full. Dates are returned in an ISO 8601 format (YYYY-MM-DD).

Format: date
next_monthly_payment
nullablenumber
The amount of the next payment.

Format: double
next_payment_due_date
nullablestring
The due date for the next payment. Dates are returned in an ISO 8601 format (YYYY-MM-DD).

Format: date
origination_date
nullablestring
The date on which the loan was initially lent. Dates are returned in an ISO 8601 format (YYYY-MM-DD).

Format: date
origination_principal_amount
nullablenumber
The original principal balance of the mortgage.

Format: double
past_due_amount
nullablenumber
Amount of loan (principal + interest) past due for payment.

Format: double
property_address
object
Object containing fields describing property address.
city
nullablestring
The city name.
country
nullablestring
The ISO 3166-1 alpha-2 country code.
postal_code
nullablestring
The five or nine digit postal code.
region
nullablestring
The region or state (example "NC").
street
nullablestring
The full street address (example "564 Main Street, Apt 15").
ytd_interest_paid
nullablenumber
The year to date (YTD) interest paid.

Format: double
ytd_principal_paid
nullablenumber
The YTD principal paid.

Format: double
student
nullable[object]
The student loan accounts returned.
account_id
nullablestring
The ID of the account that this liability belongs to. Each account can only contain one liability.
account_number
nullablestring
The account number of the loan. For some institutions, this may be a masked version of the number (e.g., the last 4 digits instead of the entire number).
disbursement_dates
nullable[string]
The dates on which loaned funds were disbursed or will be disbursed. These are often in the past. Dates are returned in an ISO 8601 format (YYYY-MM-DD).

Format: date
expected_payoff_date
nullablestring
The date when the student loan is expected to be paid off. Availability for this field is limited. Dates are returned in an ISO 8601 format (YYYY-MM-DD).

Format: date
guarantor
nullablestring
The guarantor of the student loan.
interest_rate_percentage
number
The interest rate on the loan as a percentage.

Format: double
is_overdue
nullableboolean
true if a payment is currently overdue. Availability for this field is limited.
last_payment_amount
nullablenumber
The amount of the last payment.

Format: double
last_payment_date
nullablestring
The date of the last payment. Dates are returned in an ISO 8601 format (YYYY-MM-DD).

Format: date
last_statement_balance
nullablenumber
The total amount owed as of the last statement issued

Format: double
last_statement_issue_date
nullablestring
The date of the last statement. Dates are returned in an ISO 8601 format (YYYY-MM-DD).

Format: date
loan_name
nullablestring
The type of loan, e.g., "Consolidation Loans".
loan_status
object
An object representing the status of the student loan
end_date
nullablestring
The date until which the loan will be in its current status. Dates are returned in an ISO 8601 format (YYYY-MM-DD).

Format: date
type
nullablestring
The status type of the student loan

Possible values: 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
nullablenumber
The minimum payment due for the next billing cycle. There are some exceptions: Some institutions require a minimum payment across all loans associated with an account number. Our API presents that same minimum payment amount on each loan. The institutions that do this are: Great Lakes ( 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.

Format: double
next_payment_due_date
nullablestring
The due date for the next payment. The due date is 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).

Format: date
origination_date
nullablestring
The date on which the loan was initially lent. Dates are returned in an ISO 8601 format (YYYY-MM-DD).

Format: date
origination_principal_amount
nullablenumber
The original principal balance of the loan.

Format: double
outstanding_interest_amount
nullablenumber
The total dollar amount of the accrued interest balance. For Sallie Mae ( ins_116944), this amount is included in the current balance of the loan, so this field will return as null.

Format: double
payment_reference_number
nullablestring
The relevant account number that should be used to reference this loan for payments. In the majority of cases, payment_reference_number will match account_number, but in some institutions, such as Great Lakes (ins_116861), it will be different.
repayment_plan
object
An object representing the repayment plan for the student loan
description
nullablestring
The description of the repayment plan as provided by the servicer.
type
nullablestring
The type of the repayment plan.

Possible values: 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
nullablestring
The sequence number of the student loan. Heartland ECSI (ins_116948) does not make this field available.
servicer_address
object
The address of the student loan servicer. This is generally the remittance address to which payments should be sent.
city
nullablestring
The full city name
region
nullablestring
The region or state Example: "NC"
street
nullablestring
The full street address Example: "564 Main Street, APT 15"
postal_code
nullablestring
The postal code
country
nullablestring
The ISO 3166-1 alpha-2 country code
ytd_interest_paid
nullablenumber
The year to date (YTD) interest paid. Availability for this field is limited.

Format: double
ytd_principal_paid
nullablenumber
The year to date (YTD) principal paid. Availability for this field is limited.

Format: double
request_id
string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
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      "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": null
26      },
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": null
41      },
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": null
56      },
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    "item_id": "eVBnVMp7zdTJLkRNr33Rs6zr7KNJqBFL9DrE6",
80    "update_type": "background",
81    "webhook": "https://www.genericwebhookurl.com/webhook"
82  },
83  "liabilities": {
84    "credit": [
85      {
86        "account_id": "dVzbVMLjrxTnLjX4G66XUp5GLklm4oiZy88yK",
87        "aprs": [
88          {
89            "apr_percentage": 15.24,
90            "apr_type": "balance_transfer_apr",
91            "balance_subject_to_apr": 1562.32,
92            "interest_charge_amount": 130.22
93          },
94          {
95            "apr_percentage": 27.95,
96            "apr_type": "cash_apr",
97            "balance_subject_to_apr": 56.22,
98            "interest_charge_amount": 14.81
99          },
100          {
101            "apr_percentage": 12.5,
102            "apr_type": "purchase_apr",
103            "balance_subject_to_apr": 157.01,
104            "interest_charge_amount": 25.66
105          },
106          {
107            "apr_percentage": 0,
108            "apr_type": "special",
109            "balance_subject_to_apr": 1000,
110            "interest_charge_amount": 0
111          }
112        ],
113        "is_overdue": false,
114        "last_payment_amount": 168.25,
115        "last_payment_date": "2019-05-22",
116        "last_statement_issue_date": "2019-05-28",
117        "last_statement_balance": 1708.77,
118        "minimum_payment_amount": 20,
119        "next_payment_due_date": "2020-05-28"
120      }
121    ],
122    "mortgage": [
123      {
124        "account_id": "BxBXxLj1m4HMXBm9WZJyUg9XLd4rKEhw8Pb1J",
125        "account_number": "3120194154",
126        "current_late_fee": 25,
127        "escrow_balance": 3141.54,
128        "has_pmi": true,
129        "has_prepayment_penalty": true,
130        "interest_rate": {
131          "percentage": 3.99,
132          "type": "fixed"
133        },
134        "last_payment_amount": 3141.54,
135        "last_payment_date": "2019-08-01",
136        "loan_term": "30 year",
137        "loan_type_description": "conventional",
138        "maturity_date": "2045-07-31",
139        "next_monthly_payment": 3141.54,
140        "next_payment_due_date": "2019-11-15",
141        "origination_date": "2015-08-01",
142        "origination_principal_amount": 425000,
143        "past_due_amount": 2304,
144        "property_address": {
145          "city": "Malakoff",
146          "country": "US",
147          "postal_code": "14236",
148          "region": "NY",
149          "street": "2992 Cameron Road"
150        },
151        "ytd_interest_paid": 12300.4,
152        "ytd_principal_paid": 12340.5
153      }
154    ],
155    "student": [
156      {
157        "account_id": "Pp1Vpkl9w8sajvK6oEEKtr7vZxBnGpf7LxxLE",
158        "account_number": "4277075694",
159        "disbursement_dates": [
160          "2002-08-28"
161        ],
162        "expected_payoff_date": "2032-07-28",
163        "guarantor": "DEPT OF ED",
164        "interest_rate_percentage": 5.25,
165        "is_overdue": false,
166        "last_payment_amount": 138.05,
167        "last_payment_date": "2019-04-22",
168        "last_statement_issue_date": "2019-04-28",
169        "last_statement_balance": 1708.77,
170        "loan_name": "Consolidation",
171        "loan_status": {
172          "end_date": "2032-07-28",
173          "type": "repayment"
174        },
175        "minimum_payment_amount": 25,
176        "next_payment_due_date": "2019-05-28",
177        "origination_date": "2002-08-28",
178        "origination_principal_amount": 25000,
179        "outstanding_interest_amount": 6227.36,
180        "payment_reference_number": "4277075694",
181        "pslf_status": {
182          "estimated_eligibility_date": "2021-01-01",
183          "payments_made": 200,
184          "payments_remaining": 160
185        },
186        "repayment_plan": {
187          "description": "Standard Repayment",
188          "type": "standard"
189        },
190        "sequence_number": "1",
191        "servicer_address": {
192          "city": "San Matias",
193          "country": "US",
194          "postal_code": "99415",
195          "region": "CA",
196          "street": "123 Relaxation Road"
197        },
198        "ytd_interest_paid": 280.55,
199        "ytd_principal_paid": 271.65
200      }
201    ]
202  },
203  "request_id": "dTnnm60WgKGLnKL"
204}

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
string
LIABILITIES
webhook_code
string
DEFAULT_UPDATE
item_id
string
The item_id of the Item associated with this webhook, warning, or error
error
object
Errors are identified by 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
string
A broad categorization of the error. Safe for programmatic use.

Possible values: 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
string
The particular error code. Safe for programmatic use.
error_code_reason
string
The specific reason for the error code. Currently, reasons are only supported OAuth-based item errors; 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
string
A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.
display_message
string
A user-friendly representation of the error code. null if the error is not related to user action.
This may change over time and is not safe for programmatic use.
request_id
string
A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.
causes
array
In this product, a request can pertain to more than one Item. If an error is returned for such a request, 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
integer
The HTTP status code associated with the error. This will only be returned in the response body when the error information is provided via a webhook.
documentation_url
string
The URL of a Plaid documentation page with more information about the error
suggested_action
string
Suggested steps for resolving the error
account_ids_with_new_liabilities
[string]
An array of account_id's for accounts that contain new liabilities.'
account_ids_with_updated_liabilities
object
An object with keys of account_id's that are mapped to their respective liabilities fields that changed.
Example: { "XMBvvyMGQ1UoLbKByoMqH3nXMj84ALSdE5B58": ["past_amount_due"] }
environment
string
The Plaid environment the webhook was sent from

Possible values: 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}