Bank Feeds

Invite a company to connect a bank by text and email

Sends the company the same secure no-login first-time bank-connect link by both text and email. Each channel is attempted independently. Use for a client adding a new bank/card; use the reconnect endpoints for a broken feed. Reuses the company's open bank-connection task.

post/bank-feeds/send-connect-invite

Request

  • Base URL: https://ledgerhq.pro/api/v1
  • URL: https://ledgerhq.pro/api/v1/bank-feeds/send-connect-invite
  • Auth: one of:
    • HTTP bearer and API key in header x-organization-id
    • HTTP bearer and API key in header x-organization-id

Request body

channel'sms' | 'email' | 'both'

Compatibility input. Bank connection invites always attempt both text and email.

requestedAccountNamestring

Bank/account request shown to the client; list multiple banks on separate lines

requestedItemsstring[]

Banks/cards to connect as a checklist the client works through

advisorMessagestring

Optional note explaining what to connect and why

ownerIdstring uuid nullable

Equal owner to contact; defaults to the selected bank-outreach owner

Response

Send result (status + per-channel sms/email statuses)

Changes

No recorded changes to this operation across all 5 revisions of this API.