Retrieve Liabilities data
Changed onThe /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. Supported account types are account type credit with account subtype credit card or paypal; and account type loan with account subtype auto, commercial, commercial line of credit, consumer, home equity, home equity loan, line of credit, loan, mortgage, or student. 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.
To receive the expanded loan subtype values, use plaid-go 10.1.0 or later, plaid-java 44.0.0 or later, plaid-python 8.3.0 or later, or plaid-ruby 14.4.0 or later. Earlier client library versions may receive loan instead of home equity loan and line of credit instead of commercial line of credit.
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.
Request
- Base URLhttps://production.plaid.com
- URLhttps://production.plaid.com/liabilities/get
- AuthAPI key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version
Request body
Response
OK
Changes
- warning
added the new
CRA_PARTNER_INSIGHTS_ERRORenum value to theresponse property for the response status - warning
added the new
CRA_PARTNER_INSIGHTS_ERRORenum value to the//response property for the response status - warning
added the new
CRA_REPORT_ERRORenum value to theresponse property for the response status - warning
added the new
CRA_REPORT_ERRORenum value to the//response property for the response status - info
added the optional property
//to the response with the status
- warning
- info
added the optional property
/to the response with the status - info
added the optional property
///to the response with the status - info
removed the
charge cardenum value from the//response property for the response status - info
removed the
installmentenum value from the//response property for the response status
- info