Update an Account

This operation updates account information.

If all parameters are valid and updates have been made, it returns with status code 200. The response is the account model.

Path Params
uuid
required

Account identifier.

Body Params
agreements
array of objects

Additional agreements, or new revisions of existing agreements, read and signed by the account holder.

agreements
boolean

If provided, updates whether the account is enabled for Instant ACH by the partner. Omitting the field leaves the current setting unchanged.

beneficiaries
array of objects
beneficiaries
cash_interest
object

Use this property to change the account's configuration for the USD cash interest program.
To enroll the account, specify the apr_tier_name. The status should not be specified on enrollment.
To change the APR tier, specify the new apr_tier_name. The status should not be specified on tier changes.
The unenroll, set the status to INACTIVE.
After any change, the response will contain a status of PENDING_CHANGE.
An event showing the status change to ACTIVE (for enrollment or tier changes) or INACTIVE (for unenrollment) will be generated when the change is complete.

contact
object

Contact is the model for the account owner contact information.

disclosures
object

Disclosures fields denote if the account owner falls under
each category defined by FINRA rule. The client has to ask
questions for the end user and the values should reflect
their answers.
If one of the answers is true (yes), the account goes into
ACTION_REQUIRED status.

drip
object

This feature is available in sandbox for beta partners only.

The account's dividend reinvestment (DRIP) setting. Omit drip to keep the current setting.

To turn DRIP on, the account must have a signed customer agreement at the revision that Alpaca requires. The agreement can already be on the account, or you can send it in agreements in the same request. Otherwise the request fails with HTTP 422, and the error message names the required revision.

DRIP enrollment must be available in the environment. While it is not, a request that turns DRIP on is accepted with HTTP 200 and does not enroll the account. The agreement is not checked, and the response has no drip object unless the account was enrolled before.

DRIP is not available for donor_advised, trust, omnibus_sub, and omnibus_non_disclosed accounts. A request that turns DRIP on for one of these accounts fails with HTTP 422, even while DRIP enrollment is unavailable. A request that turns DRIP off is accepted.

enabled_assets
array of objects

The asset classes enabled on the account. Omit this field to leave the
account's enabled assets unchanged. Updates are additive only: the
submitted list must contain every asset class already enabled on the account,
because asset removal is not supported. For example, to enable
crypto for an account that currently trades only equities, submit
["us_equity", "crypto"] together with the signed crypto agreement.
us_option may appear in this list for options-enabled accounts and
must be re-listed on additive updates, but options cannot be enabled
through this endpoint.

enabled_assets
Allowed:
fpsl
object

The account's Fully Paid Securities Lending (FPSL) configuration.
Use this property to change the account's configuration for the FPSL program.
To enroll the account for a market, specify the tier_id. The status should not be specified on enrollment.
To change the tier, specify the new tier_id. The status should not be specified on tier changes.
To unenroll, set the status to INACTIVE.
To re-enroll the account, set the status to ACTIVE. You can also specify the tier_id in case you want to change it.
Currently only US market is supported.

identity
object

Identity is the model to provide account owner's identity information.

uuid

The UUID of the primary account holder. This field is immutable after the account is created.

  • Omitting the field, or supplying the value already associated with the account, is a no-op.
  • Supplying a value different from the current primary account holder returns HTTP 403.
trusted_contact
object

This model input is optional. However, the client should make a reasonable effort to obtain the trusted contact information. See FINRA Notice 17-11 for more details.

At least one of the following is required:

  • email_address
  • phone_number
  • street_address
Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json