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.
account_titlestringRequired<=128 characters
account_typeenumRequired
depositor_idslist of stringsRequired
signer_primarystring or nullOptional<=64 characters
signer_primary_tinstring or nullOptional<=9 characters
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
cost_center_idstring or nullOptionalformat: "uuid"
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.
is_receiving_printed_statementsbooleanOptionalDefaults to false
Whether this account should receive printed statements.
account_officerstring or nullOptional<=128 characters

Account officer assigned to this account (free-text)

is_non_interest_bearingbooleanOptionalDefaults to false

Whether this account is non-interest-bearing. If true, no interest rates, tiers, or pricing groups can be assigned.

custom_field_1string or nullOptional<=255 characters
Custom field 1
custom_field_2string or nullOptional<=255 characters
Custom field 2
custom_field_3string or nullOptional<=255 characters
Custom field 3
custom_field_4string or nullOptional<=255 characters
Custom field 4
institution_account_idstring or nullOptional<=32 charactersDeprecated

Response

Successful Response
idstring
institution_idstring
signer_primarystring or null
account_titlestring
interest_ratestring
interest_rate_tierslist of objects
insurance_limitstring
account_typeenum
created_atstring
is_joint_accountboolean
total_balancestring
pending_balancestring
is_reciprocation_prioritizedboolean
is_receiving_printed_statementsboolean
rate_configurationenum
signer_primary_tin_last4string or null
closed_atstring or null
signer_secondarystring or null
beneficiary_namestring or null
beneficiary_tinstring or null
beneficiary_tin_last4string or null
institution_sweep_account_idstring or null
institution_return_account_idstring or null
institution_branch_idstring or null
cost_center_idstring or null
cost_center_codestring 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
ratestring or null
floating_spreadstring or null
floating_spread_bpsstring or null
rate_index_typeenum or null
floating_rate_percentagestring or null
index_ratestring or null
custom_benchmark_idstring or null
custom_benchmark_ratestring or null
account_officerstring or null
Account officer assigned to this account
is_non_interest_bearingbooleanDefaults to false

Whether this account is non-interest-bearing

custom_field_1string or null
Custom field 1
custom_field_2string or null
Custom field 2
custom_field_3string or null
Custom field 3
custom_field_4string or null
Custom field 4
institution_account_idstring or nullDeprecated
institution_alternative_idstring or nullDeprecated

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
500
Internal Server Error