Skip to main content
POST
Create new SimpleFIN connection

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
name
string | null

Display name for the connection.

Maximum string length: 255
app
enum<string> | null

Which SimpleFIN app this connection is for (drives the card, icon, and setup guide; no effect on protocol behavior).

Available options:
actual_budget,
other
all_accounts
boolean

Expose every financial account the user owns, including ones connected in the future. When true, financial_accounts is ignored.

financial_accounts
integer[] | null

IDs of the financial accounts to expose.

enabled
boolean

Whether the connection is enabled. Disabled connections reject pulls.

Response

message
string
required
Allowed value: "SimpleFIN connection created."
data
SimpleFinConnectionResource · object
required