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

Class KYCResults

java.lang.Object
markets.alpaca.client.openapi.broker.model.KYCResults
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class KYCResults extends Object implements Serializable
Hold information about the result of KYC. Please see the documentation [here](https://alpaca.markets/docs/api-references/broker-api/events/#kyc-results) for more indepth details
See Also:

  • Field Details

  • Constructor Details

    • KYCResults

      public KYCResults()

  • Method Details

    • accept

      public KYCResults accept(@Nullable String accept)

    • getAccept

      @Nullable public String getAccept()
      IDENTITY_VERIFICATION Identity needs to be verified TAX_IDENTIFICATION Tax ID number needs to be verified ADDRESS_VERIFICATION Address needs to be verified DATE_OF_BIRTH Date of birth needs to be verified INVALID_IDENTITY_PASSPORT Identity needs to be verified via a government issued ID. This is commonly used in conjuction with OTHER to describe the exact document needed. SELFIE_VERIFICATION Identity needs to be verified via a live selfie of the account owner PEP Further information needs to be submitted if account owner is politically exposed person FAMILY_MEMBER_PEP Further information needs to be submitted if family member is a politically exposed person CONTROL_PERSON Further information needs to be submitted if account owner is a control person AFFILIATED Further information needs to be submitted if account owner is affiliated to finra or an exchange VISA_TYPE_OTHER Further information needs to be submitted about account owner's visa W8BEN_CORRECTION Idenfitying information submitted by the user was incorrect so a new, corrected, W8BEN needs to be submitted COUNTRY_NOT_SUPPORTED The account owner's country of tax residence is not supported by our KYC providers. In this case, we'll manully perform KYC on the user WATCHLIST_HIT Results from the watchlist screening need further investigation before account opening. No action is needed from the user OTHER A custom message will be sent to describe exactly what is needed from the account owner. The message will be displayed in the additional_information attribute. OTHER_PARTNER A custom message will be sent to relay information relevant only to the partner. The message will be displayed in the additional_information attribute.
      Returns:
      accept

    • setAccept

      public void setAccept(@Nullable String accept)

    • additionalInformation

      public KYCResults additionalInformation(@Nullable String additionalInformation)

    • getAdditionalInformation

      @Nullable public String getAdditionalInformation()
      Used to display a custom message.
      Returns:
      additionalInformation

    • setAdditionalInformation

      public void setAdditionalInformation(@Nullable String additionalInformation)

    • indeterminate

      public KYCResults indeterminate(@Nullable String indeterminate)

    • getIndeterminate

      @Nullable public String getIndeterminate()
      IDENTITY_VERIFICATION Identity needs to be verified TAX_IDENTIFICATION Tax ID number needs to be verified ADDRESS_VERIFICATION Address needs to be verified DATE_OF_BIRTH Date of birth needs to be verified INVALID_IDENTITY_PASSPORT Identity needs to be verified via a government issued ID. This is commonly used in conjuction with OTHER to describe the exact document needed. SELFIE_VERIFICATION Identity needs to be verified via a live selfie of the account owner PEP Further information needs to be submitted if account owner is politically exposed person FAMILY_MEMBER_PEP Further information needs to be submitted if family member is a politically exposed person CONTROL_PERSON Further information needs to be submitted if account owner is a control person AFFILIATED Further information needs to be submitted if account owner is affiliated to finra or an exchange VISA_TYPE_OTHER Further information needs to be submitted about account owner's visa W8BEN_CORRECTION Idenfitying information submitted by the user was incorrect so a new, corrected, W8BEN needs to be submitted COUNTRY_NOT_SUPPORTED The account owner's country of tax residence is not supported by our KYC providers. In this case, we'll manully perform KYC on the user WATCHLIST_HIT Results from the watchlist screening need further investigation before account opening. No action is needed from the user OTHER A custom message will be sent to describe exactly what is needed from the account owner. The message will be displayed in the additional_information attribute. OTHER_PARTNER A custom message will be sent to relay information relevant only to the partner. The message will be displayed in the additional_information attribute.
      Returns:
      indeterminate

    • setIndeterminate

      public void setIndeterminate(@Nullable String indeterminate)

    • reject

      public KYCResults reject(@Nullable String reject)

    • getReject

      @Nullable public String getReject()
      IDENTITY_VERIFICATION Identity needs to be verified TAX_IDENTIFICATION Tax ID number needs to be verified ADDRESS_VERIFICATION Address needs to be verified DATE_OF_BIRTH Date of birth needs to be verified INVALID_IDENTITY_PASSPORT Identity needs to be verified via a government issued ID. This is commonly used in conjuction with OTHER to describe the exact document needed. SELFIE_VERIFICATION Identity needs to be verified via a live selfie of the account owner PEP Further information needs to be submitted if account owner is politically exposed person FAMILY_MEMBER_PEP Further information needs to be submitted if family member is a politically exposed person CONTROL_PERSON Further information needs to be submitted if account owner is a control person AFFILIATED Further information needs to be submitted if account owner is affiliated to finra or an exchange VISA_TYPE_OTHER Further information needs to be submitted about account owner's visa W8BEN_CORRECTION Idenfitying information submitted by the user was incorrect so a new, corrected, W8BEN needs to be submitted COUNTRY_NOT_SUPPORTED The account owner's country of tax residence is not supported by our KYC providers. In this case, we'll manully perform KYC on the user WATCHLIST_HIT Results from the watchlist screening need further investigation before account opening. No action is needed from the user OTHER A custom message will be sent to describe exactly what is needed from the account owner. The message will be displayed in the additional_information attribute. OTHER_PARTNER A custom message will be sent to relay information relevant only to the partner. The message will be displayed in the additional_information attribute.
      Returns:
      reject

    • setReject

      public void setReject(@Nullable String reject)

    • summary

      public KYCResults summary(@Nullable String summary)

    • getSummary

      @Nullable public String getSummary()
      Either `pass` or `fail`. Used to indicate if KYC has completed and passed or not. This field is used for internal purposes only.
      Returns:
      summary

    • setSummary

      public void setSummary(@Nullable String summary)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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