plaid

Retrieve Liabilities data

Changed on

The /processor/liabilities/get endpoint returns various details about a loan or credit account. 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.

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 /processor/liabilities/get.

Note: This request may take some time to complete if liabilities was not specified as an initial product when creating the processor token. This is because Plaid must communicate directly with the institution to retrieve the additional data.

post/processor/liabilities/get

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/processor/liabilities/get
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

Request body

client_idstring

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.

secretstring

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.

processor_tokenstring required

The processor token obtained from the Plaid integration partner. Processor tokens are in the format: processor-<environment>-<identifier>

Response

OK

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Changes

  • ea443cd78f6fRevision changes
    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the response property for the response status

    • info

      added the optional property / to the response with the status

  • e07a869352e8Revision changes
    • info

      added the optional property /// to the response with the status

    • info

      removed the charge card enum value from the / response property for the response status

    • info

      removed the installment enum value from the / response property for the response status