Financial Institutions

Get financial institution status and update requirements

get/accounts/{account_id}/financial-institutions/{fi_id}/status

Request

Base URL
https://api.brale.xyz
Auth
OAuth 2
Client credentials
Token URL: https://auth.brale.xyz/oauth2/token scopes: financial-institutions:read

account_idstring required

ID of the resource

Example:2VZvtmVc2j3gQ80CTlcuQXbGrwC

Account ID

fi_idstring required

ID of the resource

Example:2VZvtmVc2j3gQ80CTlcuQXbGrwC

Financial Institution ID

financial_institution_idstring

The ID of the financial institution

last_updatedstring date_time required

Last update timestamp

needs_updateboolean required

Whether this FI needs Plaid reauthorization

status'active' | 'archived' required

Current FI status

{
  "financial_institution_id": "fi_123456789",
  "last_updated": "2024-01-15T10:30:00Z",
  "status": "active"
}