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

Class W8benDocument

java.lang.Object
markets.alpaca.client.openapi.broker.model.W8benDocument
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class W8benDocument extends Object implements Serializable
Use this property (instead of the content property) to upload W-8 BEN data in JSON format.
See Also:

  • Field Details

  • Constructor Details

    • W8benDocument

      public W8benDocument()

  • Method Details

    • additionalConditions

      public W8benDocument additionalConditions(@Nullable String additionalConditions)

    • getAdditionalConditions

      @Nullable public String getAdditionalConditions()
      Any additional conditions to specify
      Returns:
      additionalConditions

    • setAdditionalConditions

      public void setAdditionalConditions(@Nullable String additionalConditions)

    • countryCitizen

      public W8benDocument countryCitizen(@Nonnull String countryCitizen)

    • getCountryCitizen

      @Nonnull public String getCountryCitizen()
      The country that the applicant is a citizen of
      Returns:
      countryCitizen

    • setCountryCitizen

      public void setCountryCitizen(@Nonnull String countryCitizen)

    • date

      public W8benDocument date(@Nonnull LocalDate date)

    • getDate

      @Nonnull public LocalDate getDate()
      date signed
      Returns:
      date

    • setDate

      public void setDate(@Nonnull LocalDate date)

    • dateOfBirth

      public W8benDocument dateOfBirth(@Nonnull LocalDate dateOfBirth)

    • getDateOfBirth

      @Nonnull public LocalDate getDateOfBirth()
      date of birth of applicant
      Returns:
      dateOfBirth

    • setDateOfBirth

      public void setDateOfBirth(@Nonnull LocalDate dateOfBirth)

    • foreignTaxId

      public W8benDocument foreignTaxId(@Nullable String foreignTaxId)

    • getForeignTaxId

      @Nullable public String getForeignTaxId()
      Applicant's tax id in their home country
      Returns:
      foreignTaxId

    • setForeignTaxId

      public void setForeignTaxId(@Nullable String foreignTaxId)

    • ftinNotRequired

      public W8benDocument ftinNotRequired(@Nullable Boolean ftinNotRequired)

    • getFtinNotRequired

      @Nullable public Boolean getFtinNotRequired()
      Required if foreign_tax_id and tax_id_ssn are empty.
      Returns:
      ftinNotRequired

    • setFtinNotRequired

      public void setFtinNotRequired(@Nullable Boolean ftinNotRequired)

    • fullName

      public W8benDocument fullName(@Nonnull String fullName)

    • getFullName

      @Nonnull public String getFullName()
      Full name of applicant
      Returns:
      fullName

    • setFullName

      public void setFullName(@Nonnull String fullName)

    • incomeType

      public W8benDocument incomeType(@Nullable String incomeType)

    • getIncomeType

      @Nullable public String getIncomeType()
      Income type of applicant
      Returns:
      incomeType

    • setIncomeType

      public void setIncomeType(@Nullable String incomeType)

    • ipAddress

      public W8benDocument ipAddress(@Nonnull String ipAddress)

    • getIpAddress

      @Nonnull public String getIpAddress()
      IP address of applicant when signed
      Returns:
      ipAddress

    • setIpAddress

      public void setIpAddress(@Nonnull String ipAddress)

    • mailingAddressCityState

      public W8benDocument mailingAddressCityState(@Nullable String mailingAddressCityState)

    • getMailingAddressCityState

      @Nullable public String getMailingAddressCityState()
      Mailing city/state of applicant
      Returns:
      mailingAddressCityState

    • setMailingAddressCityState

      public void setMailingAddressCityState(@Nullable String mailingAddressCityState)

    • mailingAddressCountry

      public W8benDocument mailingAddressCountry(@Nullable String mailingAddressCountry)

    • getMailingAddressCountry

      @Nullable public String getMailingAddressCountry()
      Mailing country for applicant
      Returns:
      mailingAddressCountry

    • setMailingAddressCountry

      public void setMailingAddressCountry(@Nullable String mailingAddressCountry)

    • mailingAddressStreet

      public W8benDocument mailingAddressStreet(@Nullable String mailingAddressStreet)

    • getMailingAddressStreet

      @Nullable public String getMailingAddressStreet()
      Mailing street address for applicant
      Returns:
      mailingAddressStreet

    • setMailingAddressStreet

      public void setMailingAddressStreet(@Nullable String mailingAddressStreet)

    • paragraphNumber

      public W8benDocument paragraphNumber(@Nullable String paragraphNumber)

    • getParagraphNumber

      @Nullable public String getParagraphNumber()
      Get paragraphNumber
      Returns:
      paragraphNumber

    • setParagraphNumber

      public void setParagraphNumber(@Nullable String paragraphNumber)

    • percentRateWithholding

      public W8benDocument percentRateWithholding(@Nullable Integer percentRateWithholding)

    • getPercentRateWithholding

      @Nullable public Integer getPercentRateWithholding()
      Get percentRateWithholding
      Returns:
      percentRateWithholding

    • setPercentRateWithholding

      public void setPercentRateWithholding(@Nullable Integer percentRateWithholding)

    • permanentAddressCityState

      public W8benDocument permanentAddressCityState(@Nonnull String permanentAddressCityState)

    • getPermanentAddressCityState

      @Nonnull public String getPermanentAddressCityState()
      Permanent city/state of applicant
      Returns:
      permanentAddressCityState

    • setPermanentAddressCityState

      public void setPermanentAddressCityState(@Nonnull String permanentAddressCityState)

    • permanentAddressCountry

      public W8benDocument permanentAddressCountry(@Nonnull String permanentAddressCountry)

    • getPermanentAddressCountry

      @Nonnull public String getPermanentAddressCountry()
      Permanent country of residence of applicant
      Returns:
      permanentAddressCountry

    • setPermanentAddressCountry

      public void setPermanentAddressCountry(@Nonnull String permanentAddressCountry)

    • permanentAddressStreet

      public W8benDocument permanentAddressStreet(@Nonnull String permanentAddressStreet)

    • getPermanentAddressStreet

      @Nonnull public String getPermanentAddressStreet()
      Permanent street address of applicant
      Returns:
      permanentAddressStreet

    • setPermanentAddressStreet

      public void setPermanentAddressStreet(@Nonnull String permanentAddressStreet)

    • referenceNumber

      public W8benDocument referenceNumber(@Nullable String referenceNumber)

    • getReferenceNumber

      @Nullable public String getReferenceNumber()
      Get referenceNumber
      Returns:
      referenceNumber

    • setReferenceNumber

      public void setReferenceNumber(@Nullable String referenceNumber)

    • residency

      public W8benDocument residency(@Nullable String residency)

    • getResidency

      @Nullable public String getResidency()
      Country of residency of applicant
      Returns:
      residency

    • setResidency

      public void setResidency(@Nullable String residency)

    • revision

      public W8benDocument revision(@Nonnull String revision)

    • getRevision

      @Nonnull public String getRevision()
      Revision of the W8BEN form
      Returns:
      revision

    • setRevision

      public void setRevision(@Nonnull String revision)

    • signerFullName

      public W8benDocument signerFullName(@Nonnull String signerFullName)

    • getSignerFullName

      @Nonnull public String getSignerFullName()
      Full name of signing user
      Returns:
      signerFullName

    • setSignerFullName

      public void setSignerFullName(@Nonnull String signerFullName)

    • taxIdSsn

      public W8benDocument taxIdSsn(@Nullable String taxIdSsn)

    • getTaxIdSsn

      @Nullable public String getTaxIdSsn()
      TaxID/SSN of applicant
      Returns:
      taxIdSsn

    • setTaxIdSsn

      public void setTaxIdSsn(@Nullable String taxIdSsn)

    • timestamp

      public W8benDocument timestamp(@Nonnull String timestamp)

    • getTimestamp

      @Nonnull public String getTimestamp()
      Timestamp when form data was gathered
      Returns:
      timestamp

    • setTimestamp

      public void setTimestamp(@Nonnull String timestamp)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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