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

Class CIPIdentity

java.lang.Object
markets.alpaca.client.openapi.broker.model.CIPIdentity
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class CIPIdentity extends Object implements Serializable
CIPIdentity
See Also:

  • Field Details

  • Constructor Details

    • CIPIdentity

      public CIPIdentity()

  • Method Details

    • address

      public CIPIdentity address(@Nullable String address)

    • getAddress

      @Nullable public String getAddress()
      The result of the check. Either `clear` or `consider`.
      Returns:
      address

    • setAddress

      public void setAddress(@Nullable String address)

    • addressBreakdown

      public CIPIdentity addressBreakdown(@Nullable String addressBreakdown)

    • getAddressBreakdown

      @Nullable public String getAddressBreakdown()
      a json object representing the breakdown of the `address` field. For example: {\"credit_agencies\": {\"result\": \"clear\",\"properties\":{\"number_of_matches\":\"1\"}}
      Returns:
      addressBreakdown

    • setAddressBreakdown

      public void setAddressBreakdown(@Nullable String addressBreakdown)

    • createdAt

      public CIPIdentity createdAt(@Nullable String createdAt)

    • getCreatedAt

      @Nullable public String getCreatedAt()
      datetime when identity check happened
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(@Nullable String createdAt)

    • dateOfBirth

      public CIPIdentity dateOfBirth(@Nullable String dateOfBirth)

    • getDateOfBirth

      @Nullable public String getDateOfBirth()
      The result of the check. Either `clear` or `consider`.
      Returns:
      dateOfBirth

    • setDateOfBirth

      public void setDateOfBirth(@Nullable String dateOfBirth)

    • dateOfBirthBreakdown

      public CIPIdentity dateOfBirthBreakdown(@Nullable String dateOfBirthBreakdown)

    • getDateOfBirthBreakdown

      @Nullable public String getDateOfBirthBreakdown()
      a json object representing the breakdown of the `date_of_birth` field. For example: example: {\"credit_agencies\":{\"result\": \"clear\",\"properties\": {\"number_of_matches\": \"1\"}}
      Returns:
      dateOfBirthBreakdown

    • setDateOfBirthBreakdown

      public void setDateOfBirthBreakdown(@Nullable String dateOfBirthBreakdown)

    • id

      public CIPIdentity id(@Nonnull String id)

    • getId

      @Nonnull public String getId()
      Your internal ID of check
      Returns:
      id

    • setId

      public void setId(@Nonnull String id)

    • matchedAddress

      public CIPIdentity matchedAddress(@Nullable String matchedAddress)

    • getMatchedAddress

      @Nullable public String getMatchedAddress()
      The result of the check. Either `clear` or `consider`.
      Returns:
      matchedAddress

    • setMatchedAddress

      public void setMatchedAddress(@Nullable String matchedAddress)

    • matchedAddresses

      public CIPIdentity matchedAddresses(@Nullable String matchedAddresses)

    • getMatchedAddresses

      @Nullable public String getMatchedAddresses()
      datetime when identity check happened
      Returns:
      matchedAddresses

    • setMatchedAddresses

      public void setMatchedAddresses(@Nullable String matchedAddresses)

    • result

      public CIPIdentity result(@Nullable String result)

    • getResult

      @Nullable public String getResult()
      The result of the check. Either `clear` or `consider`.
      Returns:
      result

    • setResult

      public void setResult(@Nullable String result)

    • sources

      public CIPIdentity sources(@Nullable String sources)

    • getSources

      @Nullable public String getSources()
      The result of the check. Either `clear` or `consider`.
      Returns:
      sources

    • setSources

      public void setSources(@Nullable String sources)

    • sourcesBreakdown

      public CIPIdentity sourcesBreakdown(@Nullable String sourcesBreakdown)

    • getSourcesBreakdown

      @Nullable public String getSourcesBreakdown()
      a json object representing the breakdown of `sources` field. For example: {\"total_sources\": {\"result\": \"clear\",\"properties\": {\"total_number_of_sources\": \"3\"}}}
      Returns:
      sourcesBreakdown

    • setSourcesBreakdown

      public void setSourcesBreakdown(@Nullable String sourcesBreakdown)

    • status

      public CIPIdentity status(@Nullable String status)

    • getStatus

      @Nullable public String getStatus()
      An enum representing the status of the CIPInfo \"complete\" \"withdrawn\"
      Returns:
      status

    • setStatus

      public void setStatus(@Nullable String status)

    • taxId

      public CIPIdentity taxId(@Nullable String taxId)

    • getTaxId

      @Nullable public String getTaxId()
      The result of the check. Either `clear` or `consider`.
      Returns:
      taxId

    • setTaxId

      public void setTaxId(@Nullable String taxId)

    • taxIdBreakdown

      public CIPIdentity taxIdBreakdown(@Nullable String taxIdBreakdown)

    • getTaxIdBreakdown

      @Nullable public String getTaxIdBreakdown()
      a json object representing the breakdown of the `tax_id` field
      Returns:
      taxIdBreakdown

    • setTaxIdBreakdown

      public void setTaxIdBreakdown(@Nullable String taxIdBreakdown)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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