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.25.0") public class KYCResults extends Object implements Serializable
Holds information about the result of KYC. `accept`, `indeterminate`, and `reject` are nullable sets represented as objects. Each property name is a KYC reason identifier, and every property value is always an empty object (`{}`) carrying no nested data. For example: ```json { \"IDENTITY_VERIFICATION\": {}, \"WATCHLIST_HIT\": {} } ``` Interpret each reason together with its enclosing result category and `additional_information`. Documented reason identifiers: - `IDENTITY_VERIFICATION`: A government-issued identity document is required to verify the account owner's identity. - `TAX_IDENTIFICATION`: A tax identification document is required to verify the account owner's tax identification number. - `ADDRESS_VERIFICATION`: Additional documentation, such as a government-issued ID or statement, may be required to verify the account owner's residential address. - `DATE_OF_BIRTH`: A government-issued identity document is required to verify the account owner's date of birth. - `SELFIE_VERIFICATION`: A live selfie of the account owner is required to verify identity. - `PEP`: The account owner disclosed politically exposed person status, and additional information may be required. - `FAMILY_MEMBER_PEP`: The account owner disclosed that an immediate family member is politically exposed, and additional information may be required. - `CONTROL_PERSON`: Additional company information may be required because the account owner disclosed a control position. - `AFFILIATED`: Additional firm information may be required because the account owner disclosed an affiliation with FINRA or an exchange. - `VISA_TYPE_OTHER`: The account owner's visa type and expiration date may be required because the submitted visa type was \"other.\" - `W8BEN_CORRECTION`: A new W-8BEN with corrected identifying information is required. - `COUNTRY_NOT_SUPPORTED`: The account owner's country of tax residence or legal residence is not supported for this account. - `WATCHLIST_HIT`: Watchlist screening returned a result that requires further review; no action is needed from the account owner unless separately requested. - `OTHER`: See `additional_information` for a custom message describing what is required from the account owner. - `OTHER_PARTNER`: See `additional_information` for a custom message intended for the Broker API partner. - `CITIZENSHIP_COUNTRY_NOT_SUPPORTED`: The account owner's country of citizenship is not supported for this account. - `DIFFERING_COUNTRY`: A submitted identity document was issued by a country different from the account owner's country of tax residence. - `WL_PEP_SCREENING`: Watchlist screening returned a result related to possible political exposure. - `WL_LEGAL_REGULATORY_WARNING`: Watchlist screening returned a legal or regulatory warning result. - `UNDER_MINIMUM_AGE`: The account owner does not meet the minimum age requirement for this account. - `PEP_FOREIGN`: The account owner disclosed foreign politically exposed person status, and additional information may be required. - `FAMILY_MEMBER_PEP_FOREIGN`: The account owner disclosed that an immediate family member has foreign politically exposed person status, and additional information may be required. - `DISCRETIONARY`: The account is designated for discretionary trading by a registered investment adviser and requires review. - `HIO`: Additional information and a declaration form may be required because the account owner disclosed being the head of an international organization. - `INTERNAL_CHECK`: A non-specific account-opening check contributed to the KYC outcome; no more specific reason is available. - `compromised_document`: The identity document check indicated that the document may be compromised. - `data_comparison`: Data extracted from the identity document did not pass comparison checks and requires review. - `image_integrity`: A document or selfie image did not pass image-integrity checks and requires review. The set of reason identifiers is extensible, so integrations must tolerate and preserve unrecognized values.
See Also:

  • Field Details

  • Constructor Details

    • KYCResults

      public KYCResults()

  • Method Details

    • accept

      public KYCResults accept(@Nullable Map<String,Object> accept)

    • putAcceptItem

      public KYCResults putAcceptItem(String key, Object acceptItem)

    • getAccept

      @Nullable public Map<String,Object> getAccept()
      A nullable set of KYC reason identifiers represented as property names with empty object values. See `KYCResults` for documented identifiers and interpretation guidance.
      Returns:
      accept

    • setAccept

      public void setAccept(@Nullable Map<String,Object> 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 Map<String,Object> indeterminate)

    • putIndeterminateItem

      public KYCResults putIndeterminateItem(String key, Object indeterminateItem)

    • getIndeterminate

      @Nullable public Map<String,Object> getIndeterminate()
      A nullable set of KYC reason identifiers represented as property names with empty object values. See `KYCResults` for documented identifiers and interpretation guidance.
      Returns:
      indeterminate

    • setIndeterminate

      public void setIndeterminate(@Nullable Map<String,Object> indeterminate)

    • reject

      public KYCResults reject(@Nullable Map<String,Object> reject)

    • putRejectItem

      public KYCResults putRejectItem(String key, Object rejectItem)

    • getReject

      @Nullable public Map<String,Object> getReject()
      A nullable set of KYC reason identifiers represented as property names with empty object values. See `KYCResults` for documented identifiers and interpretation guidance.
      Returns:
      reject

    • setReject

      public void setReject(@Nullable Map<String,Object> 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