Constructor Detail

Method Detail

• alpacaCustomerAgreement

   final UsKycCheckData.Builder alpacaCustomerAgreement(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

• alpacaCustomerAgreement

   final UsKycCheckData.Builder alpacaCustomerAgreement(JsonField<UsKycCheckData.AlpacaCustomerAgreement> alpacaCustomerAgreement)

  Sets Builder.alpacaCustomerAgreement to an arbitrary JSON value.

  You should usually call Builder.alpacaCustomerAgreement with a well-typed AlpacaCustomerAgreement value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• amlCheck

   final UsKycCheckData.Builder amlCheck(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.

• amlCheck

   final UsKycCheckData.Builder amlCheck(JsonField<UsKycCheckData.AmlCheck> amlCheck)

  Sets Builder.amlCheck to an arbitrary JSON value.

  You should usually call Builder.amlCheck with a well-typed AmlCheck value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• dataCitation

   final UsKycCheckData.Builder dataCitation(UsKycCheckData.DataCitation dataCitation)

  Data source citations for a KYC check.

• dataCitation

   final UsKycCheckData.Builder dataCitation(JsonField<UsKycCheckData.DataCitation> dataCitation)

  Sets Builder.dataCitation to an arbitrary JSON value.

  You should usually call Builder.dataCitation with a well-typed DataCitation value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• employment

   final UsKycCheckData.Builder employment(UsKycCheckData.Employment employment)

  Employment information for the individual

• employment

   final UsKycCheckData.Builder employment(JsonField<UsKycCheckData.Employment> employment)

  Sets Builder.employment to an arbitrary JSON value.

  You should usually call Builder.employment with a well-typed Employment value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• financialProfile

   final UsKycCheckData.Builder financialProfile(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

• financialProfile

   final UsKycCheckData.Builder financialProfile(JsonField<UsKycCheckData.FinancialProfile> financialProfile)

  Sets Builder.financialProfile to an arbitrary JSON value.

  You should usually call Builder.financialProfile with a well-typed FinancialProfile value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• identity

   final UsKycCheckData.Builder identity(UsKycCheckData.Identity identity)

  Identity information for the individual

• identity

   final UsKycCheckData.Builder identity(JsonField<UsKycCheckData.Identity> identity)

  Sets Builder.identity to an arbitrary JSON value.

  You should usually call Builder.identity with a well-typed Identity value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• kycMetadata

   final UsKycCheckData.Builder kycMetadata(UsKycCheckData.KycMetadata kycMetadata)

  Metadata about the KYC check.

• kycMetadata

   final UsKycCheckData.Builder kycMetadata(JsonField<UsKycCheckData.KycMetadata> kycMetadata)

  Sets Builder.kycMetadata to an arbitrary JSON value.

  You should usually call Builder.kycMetadata with a well-typed KycMetadata value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• riskDisclosure

   final UsKycCheckData.Builder riskDisclosure(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.

• riskDisclosure

   final UsKycCheckData.Builder riskDisclosure(JsonField<UsKycCheckData.RiskDisclosure> riskDisclosure)

  Sets Builder.riskDisclosure to an arbitrary JSON value.

  You should usually call Builder.riskDisclosure with a well-typed RiskDisclosure value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• trustedContact

   final UsKycCheckData.Builder trustedContact(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>

• trustedContact

   final UsKycCheckData.Builder trustedContact(JsonField<UsKycCheckData.TrustedContact> trustedContact)

  Sets Builder.trustedContact to an arbitrary JSON value.

  You should usually call Builder.trustedContact with a well-typed TrustedContact value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• usImmigrationInfo

   final UsKycCheckData.Builder usImmigrationInfo(UsKycCheckData.UsImmigrationInfo usImmigrationInfo)

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

• usImmigrationInfo

   final UsKycCheckData.Builder usImmigrationInfo(Optional<UsKycCheckData.UsImmigrationInfo> usImmigrationInfo)

  Alias for calling Builder.usImmigrationInfo with usImmigrationInfo.orElse(null).

• usImmigrationInfo

   final UsKycCheckData.Builder usImmigrationInfo(JsonField<UsKycCheckData.UsImmigrationInfo> usImmigrationInfo)

  Sets Builder.usImmigrationInfo to an arbitrary JSON value.

  You should usually call Builder.usImmigrationInfo with a well-typed UsImmigrationInfo value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalProperties

   final UsKycCheckData.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

   final UsKycCheckData.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

   final UsKycCheckData.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

• removeAdditionalProperty

   final UsKycCheckData.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final UsKycCheckData.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final UsKycCheckData build()

  Returns an immutable instance of UsKycCheckData.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

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