Launch an interactive wizard to connect a new bank or credit card account. Renders a guided UI for searching institutions, entering credentials, and handling MFA verification.

Open the account management UI to select, rename, and organize your linked bank accounts.

Search for banks and financial institutions by name

Create a new bank connection with login credentials. Returns a job ID for polling.

Check the status of a connection or refresh job. Poll every 4-5 seconds. If MFA fields appear (SecurityQuestion, TokenMethod, TokenSentFlag, CaptchaImage), use answer_mfa. Done when LastStatus is "Completed" — SuccessFlag true or null means success, false means failure. Refresh jobs may never set SuccessFlag.

Submit an MFA response (security question answer, verification code, captcha, etc.)

List accounts for a specific bank connection

Save account selection and custom names after connecting a bank. Called by the wizard after the user configures their accounts.

Read stored account preferences (selection, custom names) for a connection.

Set or clear a custom display name for a bank account. Pass null to restore the original name.

Show or hide a bank account from the active list.

List all linked bank connections (UserInstitutions) for this account, with local storage overlays (logo, selected account count).

List accounts for a bank connection. By default only shows selected (active) accounts with custom name overrides. Use includeAll to show hidden accounts too.

Get transactions for a bank account. Defaults to last 90 days.

Trigger a fresh data pull from the bank for a specific account. Returns a job ID. IMPORTANT: You must poll this job with poll_job (every 4-5 seconds) just like a new connection — the bank may require MFA during refresh. Use answer_mfa if MFA fields appear. Poll until SuccessFlag is true or false.