API ReferenceAccounts

Create Account

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

idempotency-keystringRequired

Request

This endpoint expects an object.
signer_primarystringRequired<=64 characters
account_titlestringRequired<=128 characters
account_typeenumRequired
Allowed values:
depositor_idslist of stringsRequired
depositorobject or nullOptional
New depositor to create and link to this account
interest_rate_tierslist of objectsOptional

Used to define tiers of interest rates based on account balance. If only one tier is needed, use the interest_rate field instead.

program_tagslist of stringsOptional
is_apybooleanOptionalDefaults to false

Indicates if the interest rate is an Annual Percentage Yield (APY). If ommitted or false, the rate is considered a nominal interest rate.

interest_ratedouble or nullOptional>=0

Interest rate must be between 0 and 1 (e.g., 0.04 for 4%).

signer_secondarystring or nullOptional<=64 characters
beneficiary_namestring or nullOptional<=64 characters
beneficiary_tinstring or nullOptional<=9 characters
institution_sweep_account_idstring or nullOptional<=64 characters
institution_return_account_idstring or nullOptional<=64 characters
institution_branch_idstring or nullOptional<=64 characters
institution_cost_center_idstring or nullOptional<=64 characters
managed_sweep_target_balancedouble or string or nullOptional

Target balance for managed sweep accounts. Must be a non-negative USD amount.

shadow_accountobject or nullOptional
Configuration for shadow account associated with this account.
account_agreement_file_datastring or nullOptional

Base64 encoded PDF file data (max 25MB)

notesstring or nullOptional<=256 characters
Notes for the account
pricing_group_idstring or nullOptionalformat: "uuid"
Pricing group ID associated with the account
is_reciprocation_prioritizedbooleanOptionalDefaults to false
Whether this account should be prioritized for reciprocation.
institution_account_idstring or nullOptional<=32 charactersDeprecated

Response

Successful Response
idstring
institution_idstring
signer_primarystring
account_titlestring
interest_ratestring
interest_rate_tierslist of objects
insurance_limitstring
account_typeenum
Allowed values:
created_atstring
is_joint_accountboolean
total_balancestring
pending_balancestring
is_reciprocation_prioritizedboolean
closed_atstring or null
signer_secondarystring or null
beneficiary_namestring or null
beneficiary_tinstring or null
institution_sweep_account_idstring or null
institution_return_account_idstring or null
institution_branch_idstring or null
depositorslist of objects or null
managed_sweep_target_balancestring or null
shadow_accountobject or null
notesstring or null
pricing_group_idstring or null
institution_account_idstring or nullDeprecated

Errors