Create Financial Account

POST/company/{id}/accounts

Path Parameters

id*string

The company ID

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

nativeId*string

Length1 <= length

name*string

Length1 <= length

mask*string

type*string

Value in

"Investment"
"Invoice"
"Credit"
"Depository"
"Loan"
"Other"
"Payroll"
"Fintech"
"Sweep"

currency*string

ISO 4217 currency code

Length3 <= length <= 3

subType?string

Value in

"Annuity"
"Brokerage"
"BrokerageForMinors"
"CD"
"Checking"
"CreditCard"
"EducationSavingsAccount"
"HSA"
"Investment"
"LineOfCredit"
"Loan"
"MoneyMarket"
"Mortgage"
"Other"
"PayPal"
"Prepaid"
"ProfitSharingPlan"
"Retirement"
"Savings"
"StockPlan"
"Stripe"
"TaxAdvantagedInvestment"
"Trust"
"Unknown"
"CashLike"

Response Body

`application/json`

curl -X POST "https://example.com/company/string/accounts" \  -H "Content-Type: application/json" \  -d '{    "nativeId": "string",    "name": "string",    "mask": "string",    "type": "Investment",    "currency": "str"  }'

{  "id": "string",  "nativeId": "string",  "name": "string",  "mask": "string",  "type": "Investment",  "subType": "Annuity",  "currentBalance": {    "amount": "string",    "currency": "str"  },  "status": "Syncing",  "lastUpdatedAt": "string"}

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

Path Parameters

Request Body

Response Body

`application/json`