Constructor Detail

Method Detail

• alpacaCustomerAgreement

   final UsKycCheckData.AlpacaCustomerAgreement alpacaCustomerAgreement()

  Information to affirm that the individual has read, agreed to, and signed Alpaca's customer agreement, found here: https://files.alpaca.markets/disclosures/library/AcctAppMarginAndCustAgmt.pdf

• amlCheck

   final UsKycCheckData.AmlCheck amlCheck()

  AML check information for this individual. If any of the checks have a match, provide details about the matches or hits found. The individual will be marked as high risk and be subject to manual review.

• dataCitation

   final UsKycCheckData.DataCitation dataCitation()

  Data source citations for a KYC check.

• employment

   final UsKycCheckData.Employment employment()

  Employment information for the individual

• financialProfile

   final UsKycCheckData.FinancialProfile financialProfile()

  Financial profile information for the individual <br/><br/> Examples of liquid net worth ranges: <br/> -

  $0 - $

  20,000 <br/> -

  $20,000 - $

  50,000 <br/> -

  $50,000 - $

  100,000 <br/> -

  $100,000 - $

  500,000 <br/> -

  $500,000 - $

  1,000,000

• identity

   final UsKycCheckData.Identity identity()

  Identity information for the individual

• kycMetadata

   final UsKycCheckData.KycMetadata kycMetadata()

  Metadata about the KYC check.

• riskDisclosure

   final UsKycCheckData.RiskDisclosure riskDisclosure()

  Risk information about the individual <br/><br/> Fields denote if the account owner falls under each category defined by FINRA rules. If any of the answers is true (yes), additional verifications may be required before US account approval.

• trustedContact

   final UsKycCheckData.TrustedContact trustedContact()

  Information for a trusted contact person for the individual. More information: <br/>

  • <a href="https://www.investor.gov/introduction-investing/general-resources/news-alerts/alerts-bulletins/investor-bulletins-trusted-contact" target="_blank" rel="noopener noreferrer">Investor.gov - Trusted Contact</a> <br/>

  • <a href="https://www.finra.org/investors/insights/trusted-contact" target="_blank" rel="noopener noreferrer">FINRA - Trusted Contact</a>

• usImmigrationInfo

   final Optional<UsKycCheckData.UsImmigrationInfo> usImmigrationInfo()

  US immigration information for this individual. Required if the individual is not a US citizen.

• _alpacaCustomerAgreement

   final JsonField<UsKycCheckData.AlpacaCustomerAgreement> _alpacaCustomerAgreement()

  Returns the raw JSON value of alpacaCustomerAgreement.

  Unlike alpacaCustomerAgreement, this method doesn't throw if the JSON field has an unexpected type.

• _amlCheck

   final JsonField<UsKycCheckData.AmlCheck> _amlCheck()

  Returns the raw JSON value of amlCheck.

  Unlike amlCheck, this method doesn't throw if the JSON field has an unexpected type.

• _dataCitation

   final JsonField<UsKycCheckData.DataCitation> _dataCitation()

  Returns the raw JSON value of dataCitation.

  Unlike dataCitation, this method doesn't throw if the JSON field has an unexpected type.

• _employment

   final JsonField<UsKycCheckData.Employment> _employment()

  Returns the raw JSON value of employment.

  Unlike employment, this method doesn't throw if the JSON field has an unexpected type.

• _financialProfile

   final JsonField<UsKycCheckData.FinancialProfile> _financialProfile()

  Returns the raw JSON value of financialProfile.

  Unlike financialProfile, this method doesn't throw if the JSON field has an unexpected type.

• _identity

   final JsonField<UsKycCheckData.Identity> _identity()

  Returns the raw JSON value of identity.

  Unlike identity, this method doesn't throw if the JSON field has an unexpected type.

• _kycMetadata

   final JsonField<UsKycCheckData.KycMetadata> _kycMetadata()

  Returns the raw JSON value of kycMetadata.

  Unlike kycMetadata, this method doesn't throw if the JSON field has an unexpected type.

• _riskDisclosure

   final JsonField<UsKycCheckData.RiskDisclosure> _riskDisclosure()

  Returns the raw JSON value of riskDisclosure.

  Unlike riskDisclosure, this method doesn't throw if the JSON field has an unexpected type.

• _trustedContact

   final JsonField<UsKycCheckData.TrustedContact> _trustedContact()

  Returns the raw JSON value of trustedContact.

  Unlike trustedContact, this method doesn't throw if the JSON field has an unexpected type.

• _usImmigrationInfo

   final JsonField<UsKycCheckData.UsImmigrationInfo> _usImmigrationInfo()

  Returns the raw JSON value of usImmigrationInfo.

  Unlike usImmigrationInfo, this method doesn't throw if the JSON field has an unexpected type.

• _additionalProperties

   final Map<String, JsonValue> _additionalProperties()

• toBuilder

   final UsKycCheckData.Builder toBuilder()

• validate

   final UsKycCheckData validate()

• isValid

   final Boolean isValid()

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• toString

   String toString()

• builder

   final static UsKycCheckData.Builder builder()

  Returns a mutable builder for constructing an instance of UsKycCheckData.

  The following fields are required:

  .alpacaCustomerAgreement()
  .amlCheck()
  .dataCitation()
  .employment()
  .financialProfile()
  .identity()
  .kycMetadata()
  .riskDisclosure()
  .trustedContact()