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

Class Identity

java.lang.Object
markets.alpaca.client.openapi.broker.model.Identity
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class Identity extends Object implements Serializable
Identity is the model to provide account owner's identity information.
See Also:

  • Field Details

  • Constructor Details

    • Identity

      public Identity()

  • Method Details

    • annualIncomeMax

      public Identity annualIncomeMax(@Nullable BigDecimal annualIncomeMax)

    • getAnnualIncomeMax

      @Nullable public BigDecimal getAnnualIncomeMax()
      The upper bound of the user's annual income.
      Returns:
      annualIncomeMax

    • setAnnualIncomeMax

      public void setAnnualIncomeMax(@Nullable BigDecimal annualIncomeMax)

    • annualIncomeMin

      public Identity annualIncomeMin(@Nullable BigDecimal annualIncomeMin)

    • getAnnualIncomeMin

      @Nullable public BigDecimal getAnnualIncomeMin()
      The lower bound of the user's annual income.
      Returns:
      annualIncomeMin

    • setAnnualIncomeMin

      public void setAnnualIncomeMin(@Nullable BigDecimal annualIncomeMin)

    • countryOfBirth

      public Identity countryOfBirth(@Nullable String countryOfBirth)

    • getCountryOfBirth

      @Nullable public String getCountryOfBirth()
      [ISO 3166-1 alpha-3](https://www.iso.org/iso-3166-country-codes.html).
      Returns:
      countryOfBirth

    • setCountryOfBirth

      public void setCountryOfBirth(@Nullable String countryOfBirth)

    • countryOfCitizenship

      public Identity countryOfCitizenship(@Nullable String countryOfCitizenship)

    • getCountryOfCitizenship

      @Nullable public String getCountryOfCitizenship()
      [ISO 3166-1 alpha-3](https://www.iso.org/iso-3166-country-codes.html).
      Returns:
      countryOfCitizenship

    • setCountryOfCitizenship

      public void setCountryOfCitizenship(@Nullable String countryOfCitizenship)

    • countryOfTaxResidence

      public Identity countryOfTaxResidence(@Nonnull String countryOfTaxResidence)

    • getCountryOfTaxResidence

      @Nonnull public String getCountryOfTaxResidence()
      [ISO 3166-1 alpha-3](https://www.iso.org/iso-3166-country-codes.html).
      Returns:
      countryOfTaxResidence

    • setCountryOfTaxResidence

      public void setCountryOfTaxResidence(@Nonnull String countryOfTaxResidence)

    • dateOfBirth

      public Identity dateOfBirth(@Nonnull LocalDate dateOfBirth)

    • getDateOfBirth

      @Nonnull public LocalDate getDateOfBirth()
      The date of birth in \"YYYY-MM-DD\" format.
      Returns:
      dateOfBirth

    • setDateOfBirth

      public void setDateOfBirth(@Nonnull LocalDate dateOfBirth)

    • dateOfDepartureFromUsa

      public Identity dateOfDepartureFromUsa(@Nullable LocalDate dateOfDepartureFromUsa)

    • getDateOfDepartureFromUsa

      @Nullable public LocalDate getDateOfDepartureFromUsa()
      Required if `visa_type` = B1 or B2
      Returns:
      dateOfDepartureFromUsa

    • setDateOfDepartureFromUsa

      public void setDateOfDepartureFromUsa(@Nullable LocalDate dateOfDepartureFromUsa)

    • familyName

      public Identity familyName(@Nonnull String familyName)

    • getFamilyName

      @Nonnull public String getFamilyName()
      The last name (surname) of the user.
      Returns:
      familyName

    • setFamilyName

      public void setFamilyName(@Nonnull String familyName)

    • fundingSource

      public Identity fundingSource(@Nonnull List<Identity.FundingSourceEnum> fundingSource)

    • addFundingSourceItem

      public Identity addFundingSourceItem(Identity.FundingSourceEnum fundingSourceItem)

    • getFundingSource

      @Nonnull public List<Identity.FundingSourceEnum> getFundingSource()
      Can be one or more of the following: `employment_income`, `investments`, `inheritance`, `business_income`, `savings`, `family`.
      Returns:
      fundingSource

    • setFundingSource

      public void setFundingSource(@Nonnull List<Identity.FundingSourceEnum> fundingSource)

    • givenName

      public Identity givenName(@Nonnull String givenName)

    • getGivenName

      @Nonnull public String getGivenName()
      The first/given name of the user.
      Returns:
      givenName

    • setGivenName

      public void setGivenName(@Nonnull String givenName)

    • investmentExperienceWithOptions

      public Identity investmentExperienceWithOptions(@Nullable Identity.InvestmentExperienceWithOptionsEnum investmentExperienceWithOptions)

    • getInvestmentExperienceWithOptions

      @Nullable public Identity.InvestmentExperienceWithOptionsEnum getInvestmentExperienceWithOptions()
      The user's level of expertise and familiarity with investing in Options.
      Returns:
      investmentExperienceWithOptions

    • setInvestmentExperienceWithOptions

      public void setInvestmentExperienceWithOptions(@Nullable Identity.InvestmentExperienceWithOptionsEnum investmentExperienceWithOptions)

    • investmentExperienceWithStocks

      public Identity investmentExperienceWithStocks(@Nullable Identity.InvestmentExperienceWithStocksEnum investmentExperienceWithStocks)

    • getInvestmentExperienceWithStocks

      @Nullable public Identity.InvestmentExperienceWithStocksEnum getInvestmentExperienceWithStocks()
      The user's level of expertise and familiarity with investing in US Equities.
      Returns:
      investmentExperienceWithStocks

    • setInvestmentExperienceWithStocks

      public void setInvestmentExperienceWithStocks(@Nullable Identity.InvestmentExperienceWithStocksEnum investmentExperienceWithStocks)

    • investmentObjective

      @Deprecated public Identity investmentObjective(@Nullable Identity.InvestmentObjectiveEnum investmentObjective)
      Deprecated.

    • getInvestmentObjective

      @Deprecated @Nullable public Identity.InvestmentObjectiveEnum getInvestmentObjective()
      Deprecated.
      The user's investment objective. This field is deprecated. Please use the top level `investment_objective` field.
      Returns:
      investmentObjective

    • setInvestmentObjective

      @Deprecated public void setInvestmentObjective(@Nullable Identity.InvestmentObjectiveEnum investmentObjective)
      Deprecated.

    • investmentTimeHorizon

      @Deprecated public Identity investmentTimeHorizon(@Nullable Identity.InvestmentTimeHorizonEnum investmentTimeHorizon)
      Deprecated.

    • getInvestmentTimeHorizon

      @Deprecated @Nullable public Identity.InvestmentTimeHorizonEnum getInvestmentTimeHorizon()
      Deprecated.
      The expected period of time the user plan to invest to achieve his/her financial goal(s). This field is deprecated. Please use the top level `investment_time_horizon` field.
      Returns:
      investmentTimeHorizon

    • setInvestmentTimeHorizon

      @Deprecated public void setInvestmentTimeHorizon(@Nullable Identity.InvestmentTimeHorizonEnum investmentTimeHorizon)
      Deprecated.

    • liquidNetWorthMax

      public Identity liquidNetWorthMax(@Nullable BigDecimal liquidNetWorthMax)

    • getLiquidNetWorthMax

      @Nullable public BigDecimal getLiquidNetWorthMax()
      The upper bound of the user's liquid net worth.
      Returns:
      liquidNetWorthMax

    • setLiquidNetWorthMax

      public void setLiquidNetWorthMax(@Nullable BigDecimal liquidNetWorthMax)

    • liquidNetWorthMin

      public Identity liquidNetWorthMin(@Nullable BigDecimal liquidNetWorthMin)

    • getLiquidNetWorthMin

      @Nullable public BigDecimal getLiquidNetWorthMin()
      The lower bound of the user's liquid net worth.
      Returns:
      liquidNetWorthMin

    • setLiquidNetWorthMin

      public void setLiquidNetWorthMin(@Nullable BigDecimal liquidNetWorthMin)

    • liquidityNeeds

      @Deprecated public Identity liquidityNeeds(@Nullable Identity.LiquidityNeedsEnum liquidityNeeds)
      Deprecated.

    • getLiquidityNeeds

      @Deprecated @Nullable public Identity.LiquidityNeedsEnum getLiquidityNeeds()
      Deprecated.
      The user's ability to quickly and easily convert all or part of their investments in this account to cash without significant loss in value. This field is deprecated. Please use the top level `liquidity_needs` field.
      Returns:
      liquidityNeeds

    • setLiquidityNeeds

      @Deprecated public void setLiquidityNeeds(@Nullable Identity.LiquidityNeedsEnum liquidityNeeds)
      Deprecated.

    • maritalStatus

      public Identity maritalStatus(@Nullable Identity.MaritalStatusEnum maritalStatus)

    • getMaritalStatus

      @Nullable public Identity.MaritalStatusEnum getMaritalStatus()
      The marital status of the user.
      Returns:
      maritalStatus

    • setMaritalStatus

      public void setMaritalStatus(@Nullable Identity.MaritalStatusEnum maritalStatus)

    • middleName

      public Identity middleName(@Nullable String middleName)

    • getMiddleName

      @Nullable public String getMiddleName()
      The middle name of the user.
      Returns:
      middleName

    • setMiddleName

      public void setMiddleName(@Nullable String middleName)

    • numberOfDependents

      public Identity numberOfDependents(@Nullable Integer numberOfDependents)

    • getNumberOfDependents

      @Nullable public Integer getNumberOfDependents()
      The number of dependents the user has.
      Returns:
      numberOfDependents

    • setNumberOfDependents

      public void setNumberOfDependents(@Nullable Integer numberOfDependents)

    • permanentResident

      public Identity permanentResident(@Nullable Boolean permanentResident)

    • getPermanentResident

      @Nullable public Boolean getPermanentResident()
      Only used to collect permanent residence status in the USA.
      Returns:
      permanentResident

    • setPermanentResident

      public void setPermanentResident(@Nullable Boolean permanentResident)

    • riskTolerance

      @Deprecated public Identity riskTolerance(@Nullable Identity.RiskToleranceEnum riskTolerance)
      Deprecated.

    • getRiskTolerance

      @Deprecated @Nullable public Identity.RiskToleranceEnum getRiskTolerance()
      Deprecated.
      The user's investment risk tolerance. This field is deprecated. Please use the top level `risk_tolerance` field.
      Returns:
      riskTolerance

    • setRiskTolerance

      @Deprecated public void setRiskTolerance(@Nullable Identity.RiskToleranceEnum riskTolerance)
      Deprecated.

    • taxId

      public Identity taxId(@Nullable String taxId)

    • getTaxId

      @Nullable public String getTaxId()
      Required if tax_id_type is set.
      Returns:
      taxId

    • setTaxId

      public void setTaxId(@Nullable String taxId)

    • taxIdType

      public Identity taxIdType(@Nonnull TaxIdType taxIdType)

    • getTaxIdType

      @Nonnull public TaxIdType getTaxIdType()
      Get taxIdType
      Returns:
      taxIdType

    • setTaxIdType

      public void setTaxIdType(@Nonnull TaxIdType taxIdType)

    • totalNetWorthMax

      public Identity totalNetWorthMax(@Nullable BigDecimal totalNetWorthMax)

    • getTotalNetWorthMax

      @Nullable public BigDecimal getTotalNetWorthMax()
      The upper bound of the user's total net worth.
      Returns:
      totalNetWorthMax

    • setTotalNetWorthMax

      public void setTotalNetWorthMax(@Nullable BigDecimal totalNetWorthMax)

    • totalNetWorthMin

      public Identity totalNetWorthMin(@Nullable BigDecimal totalNetWorthMin)

    • getTotalNetWorthMin

      @Nullable public BigDecimal getTotalNetWorthMin()
      The lower bound of the user's total net worth.
      Returns:
      totalNetWorthMin

    • setTotalNetWorthMin

      public void setTotalNetWorthMin(@Nullable BigDecimal totalNetWorthMin)

    • visaExpirationDate

      public Identity visaExpirationDate(@Nullable LocalDate visaExpirationDate)

    • getVisaExpirationDate

      @Nullable public LocalDate getVisaExpirationDate()
      Required if `visa_type` is set.
      Returns:
      visaExpirationDate

    • setVisaExpirationDate

      public void setVisaExpirationDate(@Nullable LocalDate visaExpirationDate)

    • visaType

      public Identity visaType(@Nullable String visaType)

    • getVisaType

      @Nullable public String getVisaType()
      Only used to collect visa types for users residing in the USA.
      Returns:
      visaType

    • setVisaType

      public void setVisaType(@Nullable String visaType)

    • putAdditionalProperty

      public Identity 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 Identity 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 Identity

    • fromJson

      public static Identity fromJson(String jsonString) throws IOException
      Create an instance of Identity given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of Identity
      Throws:
      IOException - if the JSON string is invalid with respect to Identity

    • toJson

      public String toJson()
      Convert an instance of Identity to an JSON string
      Returns:
      JSON string