institutionsGetById
Returns a JSON response containing details on a specified financial institution currently supported by Plaid.
Authorization
PLAID-CLIENT-ID PLAID-SECRET Plaid-Version In: header
In: header
In: header
Request Body
application/json
InstitutionsGetByIdRequest defines the request schema for /institutions/get_by_id
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.
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.
The ID of the institution to get details about
Specify an array of Plaid-supported country codes this institution supports, using the ISO-3166-1 alpha-2 country code standard.
Specifies optional parameters for /institutions/get_by_id. If provided, must not be null.
Response Body
application/json
application/json
curl -X POST "https://example.com/institutions/get_by_id" \ -H "Content-Type: application/json" \ -d '{ "institution_id": "string", "country_codes": [ "US" ] }'{ "institution": { "country_codes": [ "US" ], "institution_id": "ins_109512", "name": "Houndstooth Bank", "products": [ "auth", "balance", "identity", "transactions" ], "routing_numbers": [ "110000000" ], "oauth": false, "status": { "item_logins": { "status": "HEALTHY", "last_status_change": "2019-02-15T15:53:00Z", "breakdown": { "success": 0.9, "error_plaid": 0.01, "error_institution": 0.09 } }, "transactions_updates": { "status": "HEALTHY", "last_status_change": "2019-02-12T08:22:00Z", "breakdown": { "success": 0.95, "error_plaid": 0.02, "error_institution": 0.03, "refresh_interval": "NORMAL" } }, "auth": { "status": "HEALTHY", "last_status_change": "2019-02-15T15:53:00Z", "breakdown": { "success": 0.91, "error_plaid": 0.01, "error_institution": 0.08 } }, "balance": { "status": "HEALTHY", "last_status_change": "2019-02-15T15:53:00Z", "breakdown": { "success": 0.89, "error_plaid": 0.02, "error_institution": 0.09 } }, "identity": { "status": "DEGRADED", "last_status_change": "2019-02-15T15:50:00Z", "breakdown": { "success": 0.42, "error_plaid": 0.08, "error_institution": 0.5 } }, "investments": { "status": "HEALTHY", "last_status_change": "2019-02-15T15:53:00Z", "breakdown": { "success": 0.89, "error_plaid": 0.02, "error_institution": 0.09 }, "liabilities": { "status": "HEALTHY", "last_status_change": "2019-02-15T15:53:00Z", "breakdown": { "success": 0.89, "error_plaid": 0.02, "error_institution": 0.09 } } }, "investments_updates": { "status": "HEALTHY", "last_status_change": "2019-02-12T08:22:00Z", "breakdown": { "success": 0.95, "error_plaid": 0.02, "error_institution": 0.03, "refresh_interval": "NORMAL" } }, "liabilities_updates": { "status": "HEALTHY", "last_status_change": "2019-02-12T08:22:00Z", "breakdown": { "success": 0.95, "error_plaid": 0.02, "error_institution": 0.03, "refresh_interval": "NORMAL" } }, "primary_color": "#004966", "url": "https://plaid.com", "logo": null } }, "request_id": "m8MDnv9okwxFNBV"}investmentsHoldingsGet POST
The `/investments/holdings/get` endpoint allows developers to receive user-authorized stock position data for `investment`-type accounts.
institutionsGet POST
Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated. If there is no overlap between an institution’s enabled products and a client’s enabled products, then the institution will be filtered out from the response. As a result, the number of institutions returned may not match the count specified in the call.