Details relating to a specific financial institution

Unique identifier for the institution. Note that the same institution may have multiple records, each with different institution IDs; for example, if the institution has migrated to OAuth, there may be separate institution_ids for the OAuth and non-OAuth versions of the institution. Institutions that operate in different countries or with multiple login portals may also have separate institution_ids for each country or portal.

The official name of the institution.

A list of the Plaid products supported by the institution. Note that only institutions that support Instant Auth will return auth in the product array; institutions that do not list auth may still support other Auth methods such as Instant Match or Automated Micro-deposit Verification. To identify institutions that support those methods, use the auth_metadata object. For more details, see Full Auth coverage. The income_verification product here indicates support for Bank Income.

A list of the country codes supported by the institution.

The URL for the institution’s website

Hexadecimal representation of the primary color used by the institution

Base64 encoded representation of the institution’s logo, returned as a base64 encoded 152x152 PNG. Not all institutions’ logos are available.

A list of routing numbers known to be associated with the institution. This list is provided for the purpose of looking up institutions by routing number. It is generally comprehensive but is not guaranteed to be a complete list of routing numbers for an institution.

A partial list of DTC numbers associated with the institution.

Indicates that the institution has an OAuth login flow. This will be true if OAuth is supported for any Items associated with the institution, even if the institution also supports non-OAuth connections.

The status of an institution is determined by the health of its Item logins, Transactions updates, Investments updates, Liabilities updates, Auth requests, Balance requests, Identity requests, Investments requests, and Liabilities requests. A login attempt is conducted during the initial Item add in Link. If there is not enough traffic to accurately calculate an institution’s status, Plaid will return null rather than potentially inaccurate data. Institution status is accessible in the Dashboard and via the API using the /institutions/get_by_id endpoint with the include_status option set to true. Note that institution status is not available in the Sandbox environment.

A representation of the status health of a request type. Auth requests, Balance requests, Identity requests, Investments requests, Liabilities requests, Transactions updates, Investments updates, Liabilities updates, and Item logins each have their own status object.

This field is deprecated in favor of the breakdown object, which provides more granular institution health data. HEALTHY: the majority of requests are successful DEGRADED: only some requests are successful DOWN: all requests are failing

ISO 8601 formatted timestamp of the last status change for the institution.

A detailed breakdown of the institution’s performance for a request type. The values for success, error_plaid, and error_institution sum to 1. The time range used for calculating the breakdown may range from the most recent few minutes to the past six hours. In general, smaller institutions will show status that was calculated over a longer period of time. For Investment updates, which are refreshed less frequently, the period assessed may be 24 hours or more. For more details, see Institution status details.

The percentage of login attempts that are successful, expressed as a decimal.

The percentage of logins that are failing due to an internal Plaid issue, expressed as a decimal.

The percentage of logins that are failing due to an issue in the institution’s system, expressed as a decimal.

How frequently data for subscription products like Investments, Transactions, and Liabilities, is being refreshed, relative to the institution’s normal scheduling. The refresh_interval may be DELAYED or STOPPED even when the success rate is high.

A representation of the status health of a request type. Auth requests, Balance requests, Identity requests, Investments requests, Liabilities requests, Transactions updates, Investments updates, Liabilities updates, and Item logins each have their own status object.

This field is deprecated in favor of the breakdown object, which provides more granular institution health data. HEALTHY: the majority of requests are successful DEGRADED: only some requests are successful DOWN: all requests are failing

ISO 8601 formatted timestamp of the last status change for the institution.

A detailed breakdown of the institution’s performance for a request type. The values for success, error_plaid, and error_institution sum to 1. The time range used for calculating the breakdown may range from the most recent few minutes to the past six hours. In general, smaller institutions will show status that was calculated over a longer period of time. For Investment updates, which are refreshed less frequently, the period assessed may be 24 hours or more. For more details, see Institution status details.

The percentage of login attempts that are successful, expressed as a decimal.

The percentage of logins that are failing due to an internal Plaid issue, expressed as a decimal.

The percentage of logins that are failing due to an issue in the institution’s system, expressed as a decimal.

How frequently data for subscription products like Investments, Transactions, and Liabilities, is being refreshed, relative to the institution’s normal scheduling. The refresh_interval may be DELAYED or STOPPED even when the success rate is high.

A representation of the status health of a request type. Auth requests, Balance requests, Identity requests, Investments requests, Liabilities requests, Transactions updates, Investments updates, Liabilities updates, and Item logins each have their own status object.

This field is deprecated in favor of the breakdown object, which provides more granular institution health data. HEALTHY: the majority of requests are successful DEGRADED: only some requests are successful DOWN: all requests are failing

ISO 8601 formatted timestamp of the last status change for the institution.

A detailed breakdown of the institution’s performance for a request type. The values for success, error_plaid, and error_institution sum to 1. The time range used for calculating the breakdown may range from the most recent few minutes to the past six hours. In general, smaller institutions will show status that was calculated over a longer period of time. For Investment updates, which are refreshed less frequently, the period assessed may be 24 hours or more. For more details, see Institution status details.

The percentage of login attempts that are successful, expressed as a decimal.

The percentage of logins that are failing due to an internal Plaid issue, expressed as a decimal.

The percentage of logins that are failing due to an issue in the institution’s system, expressed as a decimal.

How frequently data for subscription products like Investments, Transactions, and Liabilities, is being refreshed, relative to the institution’s normal scheduling. The refresh_interval may be DELAYED or STOPPED even when the success rate is high.

A representation of the status health of a request type. Auth requests, Balance requests, Identity requests, Investments requests, Liabilities requests, Transactions updates, Investments updates, Liabilities updates, and Item logins each have their own status object.

This field is deprecated in favor of the breakdown object, which provides more granular institution health data. HEALTHY: the majority of requests are successful DEGRADED: only some requests are successful DOWN: all requests are failing

ISO 8601 formatted timestamp of the last status change for the institution.

A detailed breakdown of the institution’s performance for a request type. The values for success, error_plaid, and error_institution sum to 1. The time range used for calculating the breakdown may range from the most recent few minutes to the past six hours. In general, smaller institutions will show status that was calculated over a longer period of time. For Investment updates, which are refreshed less frequently, the period assessed may be 24 hours or more. For more details, see Institution status details.

The percentage of login attempts that are successful, expressed as a decimal.

The percentage of logins that are failing due to an internal Plaid issue, expressed as a decimal.

The percentage of logins that are failing due to an issue in the institution’s system, expressed as a decimal.

How frequently data for subscription products like Investments, Transactions, and Liabilities, is being refreshed, relative to the institution’s normal scheduling. The refresh_interval may be DELAYED or STOPPED even when the success rate is high.

A representation of the status health of a request type. Auth requests, Balance requests, Identity requests, Investments requests, Liabilities requests, Transactions updates, Investments updates, Liabilities updates, and Item logins each have their own status object.

This field is deprecated in favor of the breakdown object, which provides more granular institution health data. HEALTHY: the majority of requests are successful DEGRADED: only some requests are successful DOWN: all requests are failing

ISO 8601 formatted timestamp of the last status change for the institution.

A detailed breakdown of the institution’s performance for a request type. The values for success, error_plaid, and error_institution sum to 1. The time range used for calculating the breakdown may range from the most recent few minutes to the past six hours. In general, smaller institutions will show status that was calculated over a longer period of time. For Investment updates, which are refreshed less frequently, the period assessed may be 24 hours or more. For more details, see Institution status details.

The percentage of login attempts that are successful, expressed as a decimal.

The percentage of logins that are failing due to an internal Plaid issue, expressed as a decimal.

The percentage of logins that are failing due to an issue in the institution’s system, expressed as a decimal.

How frequently data for subscription products like Investments, Transactions, and Liabilities, is being refreshed, relative to the institution’s normal scheduling. The refresh_interval may be DELAYED or STOPPED even when the success rate is high.

A representation of the status health of a request type. Auth requests, Balance requests, Identity requests, Investments requests, Liabilities requests, Transactions updates, Investments updates, Liabilities updates, and Item logins each have their own status object.

This field is deprecated in favor of the breakdown object, which provides more granular institution health data. HEALTHY: the majority of requests are successful DEGRADED: only some requests are successful DOWN: all requests are failing

ISO 8601 formatted timestamp of the last status change for the institution.

A detailed breakdown of the institution’s performance for a request type. The values for success, error_plaid, and error_institution sum to 1. The time range used for calculating the breakdown may range from the most recent few minutes to the past six hours. In general, smaller institutions will show status that was calculated over a longer period of time. For Investment updates, which are refreshed less frequently, the period assessed may be 24 hours or more. For more details, see Institution status details.

The percentage of login attempts that are successful, expressed as a decimal.

The percentage of logins that are failing due to an internal Plaid issue, expressed as a decimal.

The percentage of logins that are failing due to an issue in the institution’s system, expressed as a decimal.

How frequently data for subscription products like Investments, Transactions, and Liabilities, is being refreshed, relative to the institution’s normal scheduling. The refresh_interval may be DELAYED or STOPPED even when the success rate is high.

A representation of the status health of a request type. Auth requests, Balance requests, Identity requests, Investments requests, Liabilities requests, Transactions updates, Investments updates, Liabilities updates, and Item logins each have their own status object.

This field is deprecated in favor of the breakdown object, which provides more granular institution health data. HEALTHY: the majority of requests are successful DEGRADED: only some requests are successful DOWN: all requests are failing

ISO 8601 formatted timestamp of the last status change for the institution.

A detailed breakdown of the institution’s performance for a request type. The values for success, error_plaid, and error_institution sum to 1. The time range used for calculating the breakdown may range from the most recent few minutes to the past six hours. In general, smaller institutions will show status that was calculated over a longer period of time. For Investment updates, which are refreshed less frequently, the period assessed may be 24 hours or more. For more details, see Institution status details.

The percentage of login attempts that are successful, expressed as a decimal.

The percentage of logins that are failing due to an internal Plaid issue, expressed as a decimal.

The percentage of logins that are failing due to an issue in the institution’s system, expressed as a decimal.

How frequently data for subscription products like Investments, Transactions, and Liabilities, is being refreshed, relative to the institution’s normal scheduling. The refresh_interval may be DELAYED or STOPPED even when the success rate is high.

A representation of the status health of a request type. Auth requests, Balance requests, Identity requests, Investments requests, Liabilities requests, Transactions updates, Investments updates, Liabilities updates, and Item logins each have their own status object.

This field is deprecated in favor of the breakdown object, which provides more granular institution health data. HEALTHY: the majority of requests are successful DEGRADED: only some requests are successful DOWN: all requests are failing

ISO 8601 formatted timestamp of the last status change for the institution.

A detailed breakdown of the institution’s performance for a request type. The values for success, error_plaid, and error_institution sum to 1. The time range used for calculating the breakdown may range from the most recent few minutes to the past six hours. In general, smaller institutions will show status that was calculated over a longer period of time. For Investment updates, which are refreshed less frequently, the period assessed may be 24 hours or more. For more details, see Institution status details.

The percentage of login attempts that are successful, expressed as a decimal.

The percentage of logins that are failing due to an internal Plaid issue, expressed as a decimal.

The percentage of logins that are failing due to an issue in the institution’s system, expressed as a decimal.

How frequently data for subscription products like Investments, Transactions, and Liabilities, is being refreshed, relative to the institution’s normal scheduling. The refresh_interval may be DELAYED or STOPPED even when the success rate is high.

Details of recent health incidents associated with the institution.

The start date of the incident, in ISO 8601 format, e.g. "2020-10-30T15:26:48Z".

The end date of the incident, in ISO 8601 format, e.g. "2020-10-30T15:26:48Z".

The title of the incident

Updates on the health incident.

The content of the update.

The status of the incident.

The date when the update was published, in ISO 8601 format, e.g. "2020-10-30T15:26:48Z".

Metadata that captures what specific payment configurations an institution supports when making Payment Initiation requests.

Indicates whether the institution supports payments from a different country.

Indicates whether the institution supports SEPA Instant payments.

A mapping of currency to maximum payment amount (denominated in the smallest unit of currency) supported by the institution. Example: {"GBP": "10000"}

Indicates whether the institution supports returning refund details when initiating a payment.

Metadata specifically related to valid Payment Initiation standing order configurations for the institution.

Indicates whether the institution supports closed-ended standing orders by providing an end date.

This is only applicable to MONTHLY standing orders. Indicates whether the institution supports negative integers (-1 to -5) for setting up a MONTHLY standing order relative to the end of the month.

A list of the valid standing order intervals supported by the institution.

Indicates whether the institution supports payment consents.

Metadata that captures information about the Auth features of an institution.

Metadata specifically related to which auth methods an institution supports.

Indicates if instant auth is supported.

Indicates if instant match is supported.

Indicates if automated microdeposits are supported.

Indicates if instant microdeposits are supported.

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