Package markets.alpaca.client.openapi.broker.model

Class AccountCreationRequest

java.lang.Object

markets.alpaca.client.openapi.broker.model.AccountCreationRequest

All Implemented Interfaces:

Serializable

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.25.0")
public class AccountCreationRequest
extends Object
implements Serializable

Fields accepted when creating an account. Requirements vary by account type, enabled assets, existing holder agreements, and correspondent configuration. The server enforces conditional requirements that are not represented statically in this schema. Account-specific requirements: - Trading accounts require inline `identity` plus `contact`, or an existing holder through `primary_account_holder_id`. Individual US equity accounts created with inline identity also require `disclosures`. - Custodial accounts require `identity` and `minor_identity`. US equity accounts also require `disclosures`. - IRA accounts require `account_sub_type`, US equity, and either inline `identity` or an existing holder through `primary_account_holder_id`; they do not support crypto. IRA accounts created with inline identity also require `disclosures`. - Donor-advised accounts require `entity_id`.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AccountCreationRequest.CustomTypeAdapterFactory
static enum	AccountCreationRequest.InvestmentObjectiveEnum	The user's investment objective.
static enum	AccountCreationRequest.InvestmentTimeHorizonEnum	The expected period of time the user plan to invest to achieve his/her financial goal(s).
static enum	AccountCreationRequest.LiquidityNeedsEnum	The user's ability to quickly and easily convert to cash all or a portion of the investments in this account without experiencing significant loss in value.
static enum	AccountCreationRequest.RiskToleranceEnum	The user's investment risk tolerance.

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_ACCOUNT_SUB_TYPE
static final String	SERIALIZED_NAME_ACCOUNT_TYPE
static final String	SERIALIZED_NAME_AGREEMENTS
static final String	SERIALIZED_NAME_ALLOW_INSTANT_ACH
static final String	SERIALIZED_NAME_BENEFICIARIES
static final String	SERIALIZED_NAME_CASH_INTEREST
static final String	SERIALIZED_NAME_CONTACT
static final String	SERIALIZED_NAME_DISCLOSURES
static final String	SERIALIZED_NAME_DOCUMENTS
static final String	SERIALIZED_NAME_ENABLED_ASSETS
static final String	SERIALIZED_NAME_ENTITY_ID
static final String	SERIALIZED_NAME_FPSL
static final String	SERIALIZED_NAME_IDENTITY
static final String	SERIALIZED_NAME_INVESTMENT_OBJECTIVE
static final String	SERIALIZED_NAME_INVESTMENT_TIME_HORIZON
static final String	SERIALIZED_NAME_LIQUIDITY_NEEDS
static final String	SERIALIZED_NAME_MINOR_IDENTITY
static final String	SERIALIZED_NAME_PRIMARY_ACCOUNT_HOLDER_ID
static final String	SERIALIZED_NAME_RISK_TOLERANCE
static final String	SERIALIZED_NAME_TRADING_CONFIGURATIONS
static final String	SERIALIZED_NAME_TRUSTED_CONTACT

Constructor Summary

Constructors

Constructor	Description
AccountCreationRequest()

Method Summary

Modifier and Type	Method	Description
AccountCreationRequest	accountSubType(AccountSubType accountSubType)
AccountCreationRequest	accountType(AccountCreationType accountType)
AccountCreationRequest	addAgreementsItem(Agreement agreementsItem)
AccountCreationRequest	addBeneficiariesItem(Beneficiary beneficiariesItem)
AccountCreationRequest	addDocumentsItem(OwnerDocumentUploadRequest documentsItem)
AccountCreationRequest	addEnabledAssetsItem(EnabledAssetClass enabledAssetsItem)
AccountCreationRequest	agreements(List<Agreement> agreements)
AccountCreationRequest	allowInstantAch(Boolean allowInstantAch)
AccountCreationRequest	beneficiaries(List<Beneficiary> beneficiaries)
AccountCreationRequest	cashInterest(AccountCashInterestPost cashInterest)
AccountCreationRequest	contact(Contact contact)
AccountCreationRequest	disclosures(Disclosures disclosures)
AccountCreationRequest	documents(List<OwnerDocumentUploadRequest> documents)
AccountCreationRequest	enabledAssets(List<EnabledAssetClass> enabledAssets)
AccountCreationRequest	entityId(UUID entityId)
boolean	equals(Object o)
AccountCreationRequest	fpsl(AccountFPSLPost fpsl)
static AccountCreationRequest	fromJson(String jsonString)	Create an instance of AccountCreationRequest given an JSON string
AccountSubType	getAccountSubType()	The account subtype.
AccountCreationType	getAccountType()	The account type.
Map<String,Object>	getAdditionalProperties()	Return the additional (undeclared) property.
Object	getAdditionalProperty(String key)	Return the additional (undeclared) property with the specified name.
List<Agreement>	getAgreements()	Agreements submitted for the account or holder.
Boolean	getAllowInstantAch()	Determines whether the account will be enabled for Instant ACH by the partner.
List<Beneficiary>	getBeneficiaries()	IRA Account only.
AccountCashInterestPost	getCashInterest()	Get cashInterest
Contact	getContact()	Get contact
Disclosures	getDisclosures()	Get disclosures
List<OwnerDocumentUploadRequest>	getDocuments()	Get documents
List<EnabledAssetClass>	getEnabledAssets()	Will default to `us_equity`.
UUID	getEntityId()	UUID of an existing legal entity used as the holder of a donor-advised account.
AccountFPSLPost	getFpsl()	Get fpsl
Identity	getIdentity()	Get identity
AccountCreationRequest.InvestmentObjectiveEnum	getInvestmentObjective()	The user's investment objective.
AccountCreationRequest.InvestmentTimeHorizonEnum	getInvestmentTimeHorizon()	The expected period of time the user plan to invest to achieve his/her financial goal(s).
AccountCreationRequest.LiquidityNeedsEnum	getLiquidityNeeds()	The user's ability to quickly and easily convert to cash all or a portion of the investments in this account without experiencing significant loss in value.
CustodialAccountMinorIdentity	getMinorIdentity()	Identity information for the minor.
UUID	getPrimaryAccountHolderId()	UUID of an existing party to use as the primary account holder.
AccountCreationRequest.RiskToleranceEnum	getRiskTolerance()	The user's investment risk tolerance.
AccountConfigurations	getTradingConfigurations()	Get tradingConfigurations
TrustedContact	getTrustedContact()	Get trustedContact
int	hashCode()
AccountCreationRequest	identity(Identity identity)
AccountCreationRequest	investmentObjective(AccountCreationRequest.InvestmentObjectiveEnum investmentObjective)
AccountCreationRequest	investmentTimeHorizon(AccountCreationRequest.InvestmentTimeHorizonEnum investmentTimeHorizon)
AccountCreationRequest	liquidityNeeds(AccountCreationRequest.LiquidityNeedsEnum liquidityNeeds)
AccountCreationRequest	minorIdentity(CustodialAccountMinorIdentity minorIdentity)
AccountCreationRequest	primaryAccountHolderId(UUID primaryAccountHolderId)
AccountCreationRequest	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
AccountCreationRequest	riskTolerance(AccountCreationRequest.RiskToleranceEnum riskTolerance)
void	setAccountSubType(AccountSubType accountSubType)
void	setAccountType(AccountCreationType accountType)
void	setAgreements(List<Agreement> agreements)
void	setAllowInstantAch(Boolean allowInstantAch)
void	setBeneficiaries(List<Beneficiary> beneficiaries)
void	setCashInterest(AccountCashInterestPost cashInterest)
void	setContact(Contact contact)
void	setDisclosures(Disclosures disclosures)
void	setDocuments(List<OwnerDocumentUploadRequest> documents)
void	setEnabledAssets(List<EnabledAssetClass> enabledAssets)
void	setEntityId(UUID entityId)
void	setFpsl(AccountFPSLPost fpsl)
void	setIdentity(Identity identity)
void	setInvestmentObjective(AccountCreationRequest.InvestmentObjectiveEnum investmentObjective)
void	setInvestmentTimeHorizon(AccountCreationRequest.InvestmentTimeHorizonEnum investmentTimeHorizon)
void	setLiquidityNeeds(AccountCreationRequest.LiquidityNeedsEnum liquidityNeeds)
void	setMinorIdentity(CustodialAccountMinorIdentity minorIdentity)
void	setPrimaryAccountHolderId(UUID primaryAccountHolderId)
void	setRiskTolerance(AccountCreationRequest.RiskToleranceEnum riskTolerance)
void	setTradingConfigurations(AccountConfigurations tradingConfigurations)
void	setTrustedContact(TrustedContact trustedContact)
String	toJson()	Convert an instance of AccountCreationRequest to an JSON string
String	toString()
AccountCreationRequest	tradingConfigurations(AccountConfigurations tradingConfigurations)
AccountCreationRequest	trustedContact(TrustedContact trustedContact)
static void	validateJsonElement(com.google.gson.JsonElement jsonElement)	Validates the JSON Element and throws an exception if issues found

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

SERIALIZED_NAME_ACCOUNT_SUB_TYPE

public static final String SERIALIZED_NAME_ACCOUNT_SUB_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_ACCOUNT_TYPE

public static final String SERIALIZED_NAME_ACCOUNT_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_AGREEMENTS

public static final String SERIALIZED_NAME_AGREEMENTS

See Also:

• Constant Field Values

SERIALIZED_NAME_ALLOW_INSTANT_ACH

public static final String SERIALIZED_NAME_ALLOW_INSTANT_ACH

See Also:

• Constant Field Values

SERIALIZED_NAME_BENEFICIARIES

public static final String SERIALIZED_NAME_BENEFICIARIES

See Also:

• Constant Field Values

SERIALIZED_NAME_CASH_INTEREST

public static final String SERIALIZED_NAME_CASH_INTEREST

See Also:

• Constant Field Values

SERIALIZED_NAME_CONTACT

public static final String SERIALIZED_NAME_CONTACT

See Also:

• Constant Field Values

SERIALIZED_NAME_DISCLOSURES

public static final String SERIALIZED_NAME_DISCLOSURES

See Also:

• Constant Field Values

SERIALIZED_NAME_DOCUMENTS

public static final String SERIALIZED_NAME_DOCUMENTS

See Also:

• Constant Field Values

SERIALIZED_NAME_ENABLED_ASSETS

public static final String SERIALIZED_NAME_ENABLED_ASSETS

See Also:

• Constant Field Values

SERIALIZED_NAME_ENTITY_ID

public static final String SERIALIZED_NAME_ENTITY_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_FPSL

public static final String SERIALIZED_NAME_FPSL

See Also:

• Constant Field Values

SERIALIZED_NAME_IDENTITY

public static final String SERIALIZED_NAME_IDENTITY

See Also:

• Constant Field Values

SERIALIZED_NAME_INVESTMENT_OBJECTIVE

public static final String SERIALIZED_NAME_INVESTMENT_OBJECTIVE

See Also:

• Constant Field Values

SERIALIZED_NAME_INVESTMENT_TIME_HORIZON

public static final String SERIALIZED_NAME_INVESTMENT_TIME_HORIZON

See Also:

• Constant Field Values

SERIALIZED_NAME_LIQUIDITY_NEEDS

public static final String SERIALIZED_NAME_LIQUIDITY_NEEDS

See Also:

• Constant Field Values

SERIALIZED_NAME_MINOR_IDENTITY

public static final String SERIALIZED_NAME_MINOR_IDENTITY

See Also:

• Constant Field Values

SERIALIZED_NAME_PRIMARY_ACCOUNT_HOLDER_ID

public static final String SERIALIZED_NAME_PRIMARY_ACCOUNT_HOLDER_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_RISK_TOLERANCE

public static final String SERIALIZED_NAME_RISK_TOLERANCE

See Also:

• Constant Field Values

SERIALIZED_NAME_TRADING_CONFIGURATIONS

public static final String SERIALIZED_NAME_TRADING_CONFIGURATIONS

See Also:

• Constant Field Values

SERIALIZED_NAME_TRUSTED_CONTACT

public static final String SERIALIZED_NAME_TRUSTED_CONTACT

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

AccountCreationRequest

public AccountCreationRequest()

Method Details

accountSubType

public AccountCreationRequest accountSubType(@Nullable
 AccountSubType accountSubType)

getAccountSubType

@Nullable
public AccountSubType getAccountSubType()

The account subtype. Required for IRA accounts.

Returns:

accountSubType

setAccountSubType

public void setAccountSubType(@Nullable
 AccountSubType accountSubType)

accountType

public AccountCreationRequest accountType(@Nullable
 AccountCreationType accountType)

getAccountType

@Nullable
public AccountCreationType getAccountType()

The account type. Defaults to `trading` when omitted.

Returns:

accountType

setAccountType

public void setAccountType(@Nullable
 AccountCreationType accountType)

agreements

public AccountCreationRequest agreements(@Nullable
 List<Agreement> agreements)

addAgreementsItem

public AccountCreationRequest addAgreementsItem(Agreement agreementsItem)

getAgreements

@Nullable
public List<Agreement> getAgreements()

Agreements submitted for the account or holder. Required agreement types depend on account type, enabled assets, existing holder agreements, and correspondent configuration. The server validates required coverage.

Returns:

agreements

setAgreements

public void setAgreements(@Nullable
 List<Agreement> agreements)

allowInstantAch

public AccountCreationRequest allowInstantAch(@Nullable
 Boolean allowInstantAch)

getAllowInstantAch

@Nullable
public Boolean getAllowInstantAch()

Determines whether the account will be enabled for Instant ACH by the partner. Defaults to false if not provided.

Returns:

allowInstantAch

setAllowInstantAch

public void setAllowInstantAch(@Nullable
 Boolean allowInstantAch)

beneficiaries

public AccountCreationRequest beneficiaries(@Nullable
 List<Beneficiary> beneficiaries)

addBeneficiariesItem

public AccountCreationRequest addBeneficiariesItem(Beneficiary beneficiariesItem)

getBeneficiaries

@Nullable
public List<Beneficiary> getBeneficiaries()

IRA Account only. A user can submit max 6 beneficiaries.

Returns:

beneficiaries

setBeneficiaries

public void setBeneficiaries(@Nullable
 List<Beneficiary> beneficiaries)

cashInterest

public AccountCreationRequest cashInterest(@Nullable
 AccountCashInterestPost cashInterest)

getCashInterest

@Nullable
public AccountCashInterestPost getCashInterest()

Get cashInterest

Returns:

cashInterest

setCashInterest

public void setCashInterest(@Nullable
 AccountCashInterestPost cashInterest)

contact

public AccountCreationRequest contact(@Nullable
 Contact contact)

getContact

@Nullable
public Contact getContact()

Get contact

Returns:

contact

setContact

public void setContact(@Nullable
 Contact contact)

disclosures

public AccountCreationRequest disclosures(@Nullable
 Disclosures disclosures)

getDisclosures

@Nullable
public Disclosures getDisclosures()

Get disclosures

Returns:

disclosures

setDisclosures

public void setDisclosures(@Nullable
 Disclosures disclosures)

documents

public AccountCreationRequest documents(@Nullable
 List<OwnerDocumentUploadRequest> documents)

addDocumentsItem

public AccountCreationRequest addDocumentsItem(OwnerDocumentUploadRequest documentsItem)

getDocuments

@Nullable
public List<OwnerDocumentUploadRequest> getDocuments()

Get documents

Returns:

documents

setDocuments

public void setDocuments(@Nullable
 List<OwnerDocumentUploadRequest> documents)

enabledAssets

public AccountCreationRequest enabledAssets(@Nullable
 List<EnabledAssetClass> enabledAssets)

addEnabledAssetsItem

public AccountCreationRequest addEnabledAssetsItem(EnabledAssetClass enabledAssetsItem)

getEnabledAssets

@Nullable
public List<EnabledAssetClass> getEnabledAssets()

Will default to `us_equity`. Alpaca has the ability to update the default value upon request.

Returns:

enabledAssets

setEnabledAssets

public void setEnabledAssets(@Nullable
 List<EnabledAssetClass> enabledAssets)

entityId

public AccountCreationRequest entityId(@Nullable
 UUID entityId)

getEntityId

@Nullable
public UUID getEntityId()

UUID of an existing legal entity used as the holder of a donor-advised account. Required for donor-advised accounts.

Returns:

entityId

setEntityId

public void setEntityId(@Nullable
 UUID entityId)

fpsl

public AccountCreationRequest fpsl(@Nullable
 AccountFPSLPost fpsl)

getFpsl

@Nullable
public AccountFPSLPost getFpsl()

Get fpsl

Returns:

fpsl

setFpsl

public void setFpsl(@Nullable
 AccountFPSLPost fpsl)

identity

public AccountCreationRequest identity(@Nullable
 Identity identity)

getIdentity

@Nullable
public Identity getIdentity()

Get identity

Returns:

identity

setIdentity

public void setIdentity(@Nullable
 Identity identity)

investmentObjective

public AccountCreationRequest investmentObjective(@Nullable
 AccountCreationRequest.InvestmentObjectiveEnum investmentObjective)

getInvestmentObjective

@Nullable
public AccountCreationRequest.InvestmentObjectiveEnum getInvestmentObjective()

The user's investment objective. This field should be used instead of the deprecated `investment_objective` under identity.

Returns:

investmentObjective

setInvestmentObjective

public void setInvestmentObjective(@Nullable
 AccountCreationRequest.InvestmentObjectiveEnum investmentObjective)

investmentTimeHorizon

public AccountCreationRequest investmentTimeHorizon(@Nullable
 AccountCreationRequest.InvestmentTimeHorizonEnum investmentTimeHorizon)

getInvestmentTimeHorizon

@Nullable
public AccountCreationRequest.InvestmentTimeHorizonEnum getInvestmentTimeHorizon()

The expected period of time the user plan to invest to achieve his/her financial goal(s). This field should be used instead of the deprecated `investment_time_horizon` under identity.

Returns:

investmentTimeHorizon

setInvestmentTimeHorizon

public void setInvestmentTimeHorizon(@Nullable
 AccountCreationRequest.InvestmentTimeHorizonEnum investmentTimeHorizon)

liquidityNeeds

public AccountCreationRequest liquidityNeeds(@Nullable
 AccountCreationRequest.LiquidityNeedsEnum liquidityNeeds)

getLiquidityNeeds

@Nullable
public AccountCreationRequest.LiquidityNeedsEnum getLiquidityNeeds()

The user's ability to quickly and easily convert to cash all or a portion of the investments in this account without experiencing significant loss in value. This field should be used instead of the deprecated `liquidity_needs` under identity.

Returns:

liquidityNeeds

setLiquidityNeeds

public void setLiquidityNeeds(@Nullable
 AccountCreationRequest.LiquidityNeedsEnum liquidityNeeds)

minorIdentity

public AccountCreationRequest minorIdentity(@Nullable
 CustodialAccountMinorIdentity minorIdentity)

getMinorIdentity

@Nullable
public CustodialAccountMinorIdentity getMinorIdentity()

Identity information for the minor. Required for custodial accounts.

Returns:

minorIdentity

setMinorIdentity

public void setMinorIdentity(@Nullable
 CustodialAccountMinorIdentity minorIdentity)

primaryAccountHolderId

public AccountCreationRequest primaryAccountHolderId(@Nullable
 UUID primaryAccountHolderId)

getPrimaryAccountHolderId

@Nullable
public UUID getPrimaryAccountHolderId()

UUID of an existing party to use as the primary account holder. Among the documented account types, existing holders are supported for trading and IRA accounts. When provided, omit inline holder fields such as `contact`, `identity`, `disclosures`, and `minor_identity`. The server validates the referenced party, account-type compatibility, eligibility, and required agreements.

Returns:

primaryAccountHolderId

setPrimaryAccountHolderId

public void setPrimaryAccountHolderId(@Nullable
 UUID primaryAccountHolderId)

riskTolerance

public AccountCreationRequest riskTolerance(@Nullable
 AccountCreationRequest.RiskToleranceEnum riskTolerance)

getRiskTolerance

@Nullable
public AccountCreationRequest.RiskToleranceEnum getRiskTolerance()

The user's investment risk tolerance. This field should be used instead of the deprecated `risk_tolerance` under identity.

Returns:

riskTolerance

setRiskTolerance

public void setRiskTolerance(@Nullable
 AccountCreationRequest.RiskToleranceEnum riskTolerance)

tradingConfigurations

public AccountCreationRequest tradingConfigurations(@Nullable
 AccountConfigurations tradingConfigurations)

getTradingConfigurations

@Nullable
public AccountConfigurations getTradingConfigurations()

Get tradingConfigurations

Returns:

tradingConfigurations

setTradingConfigurations

public void setTradingConfigurations(@Nullable
 AccountConfigurations tradingConfigurations)

trustedContact

public AccountCreationRequest trustedContact(@Nullable
 TrustedContact trustedContact)

getTrustedContact

@Nullable
public TrustedContact getTrustedContact()

Get trustedContact

Returns:

trustedContact

setTrustedContact

public void setTrustedContact(@Nullable
 TrustedContact trustedContact)

putAdditionalProperty

public AccountCreationRequest putAdditionalProperty(String key,
 Object value)

Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

Parameters:

key - name of the property

value - value of the property

Returns:

the AccountCreationRequest instance itself

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

Return the additional (undeclared) property.

Returns:

a map of objects

getAdditionalProperty

public Object getAdditionalProperty(String key)

Return the additional (undeclared) property with the specified name.

Parameters:

key - name of the property

Returns:

an object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

validateJsonElement

public static void validateJsonElement(com.google.gson.JsonElement jsonElement)
                                throws IOException

Validates the JSON Element and throws an exception if issues found

Parameters:

jsonElement - JSON Element

Throws:

IOException - if the JSON Element is invalid with respect to AccountCreationRequest

fromJson

public static AccountCreationRequest fromJson(String jsonString)
                                       throws IOException

Create an instance of AccountCreationRequest given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of AccountCreationRequest

Throws:

IOException - if the JSON string is invalid with respect to AccountCreationRequest

toJson

public String toJson()

Convert an instance of AccountCreationRequest to an JSON string

Returns:

JSON string