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

Class CIPKYC

java.lang.Object
markets.alpaca.client.openapi.broker.model.CIPKYC
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class CIPKYC extends Object implements Serializable
Represents Know Your Customer (KYC) info for a CIPInfo
See Also:

  • Field Details

  • Constructor Details

    • CIPKYC

      public CIPKYC()

  • Method Details

    • address

      public CIPKYC address(@Nullable String address)

    • getAddress

      @Nullable public String getAddress()
      Concatenated street address, city, state and country of applicant
      Returns:
      address

    • setAddress

      public void setAddress(@Nullable String address)

    • applicantName

      public CIPKYC applicantName(@Nullable String applicantName)

    • getApplicantName

      @Nullable public String getApplicantName()
      Given and family name of applicant
      Returns:
      applicantName

    • setApplicantName

      public void setApplicantName(@Nullable String applicantName)

    • approvalStatus

      public CIPKYC approvalStatus(@Nullable CIPKYC.ApprovalStatusEnum approvalStatus)

    • getApprovalStatus

      @Nullable public CIPKYC.ApprovalStatusEnum getApprovalStatus()
      Approval status of KYC check
      Returns:
      approvalStatus

    • setApprovalStatus

      public void setApprovalStatus(@Nullable CIPKYC.ApprovalStatusEnum approvalStatus)

    • approvedAt

      public CIPKYC approvedAt(@Nullable OffsetDateTime approvedAt)

    • getApprovedAt

      @Nullable public OffsetDateTime getApprovedAt()
      Reason for approving this KYC check
      Returns:
      approvedAt

    • setApprovedAt

      public void setApprovedAt(@Nullable OffsetDateTime approvedAt)

    • approvedBy

      public CIPKYC approvedBy(@Nullable String approvedBy)

    • getApprovedBy

      @Nullable public String getApprovedBy()
      Identifier of who approved KYC check
      Returns:
      approvedBy

    • setApprovedBy

      public void setApprovedBy(@Nullable String approvedBy)

    • approvedReason

      public CIPKYC approvedReason(@Nullable String approvedReason)

    • getApprovedReason

      @Nullable public String getApprovedReason()
      Datetime that this KYC check was approved
      Returns:
      approvedReason

    • setApprovedReason

      public void setApprovedReason(@Nullable String approvedReason)

    • checkCompletedAt

      public CIPKYC checkCompletedAt(@Nullable OffsetDateTime checkCompletedAt)

    • getCheckCompletedAt

      @Nullable public OffsetDateTime getCheckCompletedAt()
      completion datetime of KYC check
      Returns:
      checkCompletedAt

    • setCheckCompletedAt

      public void setCheckCompletedAt(@Nullable OffsetDateTime checkCompletedAt)

    • checkInitiatedAt

      public CIPKYC checkInitiatedAt(@Nullable OffsetDateTime checkInitiatedAt)

    • getCheckInitiatedAt

      @Nullable public OffsetDateTime getCheckInitiatedAt()
      start datetime of KYC check
      Returns:
      checkInitiatedAt

    • setCheckInitiatedAt

      public void setCheckInitiatedAt(@Nullable OffsetDateTime checkInitiatedAt)

    • countryOfResidency

      public CIPKYC countryOfResidency(@Nullable String countryOfResidency)

    • getCountryOfResidency

      @Nullable public String getCountryOfResidency()
      country for `address` field
      Returns:
      countryOfResidency

    • setCountryOfResidency

      public void setCountryOfResidency(@Nullable String countryOfResidency)

    • dateOfBirth

      public CIPKYC dateOfBirth(@Nullable LocalDate dateOfBirth)

    • getDateOfBirth

      @Nullable public LocalDate getDateOfBirth()
      DOB of applicant
      Returns:
      dateOfBirth

    • setDateOfBirth

      public void setDateOfBirth(@Nullable LocalDate dateOfBirth)

    • emailAddress

      public CIPKYC emailAddress(@Nullable String emailAddress)

    • getEmailAddress

      @Nullable public String getEmailAddress()
      email address of applicant
      Returns:
      emailAddress

    • setEmailAddress

      public void setEmailAddress(@Nullable String emailAddress)

    • id

      public CIPKYC id(@Nonnull UUID id)

    • getId

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

    • setId

      public void setId(@Nonnull UUID id)

    • ipAddress

      public CIPKYC ipAddress(@Nullable String ipAddress)

    • getIpAddress

      @Nullable public String getIpAddress()
      IP address of applicant at time of KYC check
      Returns:
      ipAddress

    • setIpAddress

      public void setIpAddress(@Nullable String ipAddress)

    • kycCompletedAt

      public CIPKYC kycCompletedAt(@Nullable OffsetDateTime kycCompletedAt)

    • getKycCompletedAt

      @Nullable public OffsetDateTime getKycCompletedAt()
      Datetime that KYC check was completed at
      Returns:
      kycCompletedAt

    • setKycCompletedAt

      public void setKycCompletedAt(@Nullable OffsetDateTime kycCompletedAt)

    • nationality

      public CIPKYC nationality(@Nullable String nationality)

    • getNationality

      @Nullable public String getNationality()
      nationality of applicant
      Returns:
      nationality

    • setNationality

      public void setNationality(@Nullable String nationality)

    • postalCode

      public CIPKYC postalCode(@Nullable String postalCode)

    • getPostalCode

      @Nullable public String getPostalCode()
      postal code for `address` field
      Returns:
      postalCode

    • setPostalCode

      public void setPostalCode(@Nullable String postalCode)

    • riskCategories

      public CIPKYC riskCategories(@Nullable List<String> riskCategories)

    • addRiskCategoriesItem

      public CIPKYC addRiskCategoriesItem(String riskCategoriesItem)

    • getRiskCategories

      @Nullable public List<String> getRiskCategories()
      The list of risk categories returned by the KYC provider or assessed
      Returns:
      riskCategories

    • setRiskCategories

      public void setRiskCategories(@Nullable List<String> riskCategories)

    • riskLevel

      public CIPKYC riskLevel(@Nullable String riskLevel)

    • getRiskLevel

      @Nullable public String getRiskLevel()
      Overall risk level returned by KYC provider or assessed
      Returns:
      riskLevel

    • setRiskLevel

      public void setRiskLevel(@Nullable String riskLevel)

    • riskScore

      public CIPKYC riskScore(@Nullable Integer riskScore)

    • getRiskScore

      @Nullable public Integer getRiskScore()
      Overall risk score returned by KYC provider or assessed
      Returns:
      riskScore

    • setRiskScore

      public void setRiskScore(@Nullable Integer riskScore)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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