Constructor Detail

Method Detail

• city

   final UsKycCheckData.Identity.Builder city(String city)

  City of the applicant.

• city

   final UsKycCheckData.Identity.Builder city(JsonField<String> city)

  Sets Builder.city to an arbitrary JSON value.

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

• countryOfCitizenship

   final UsKycCheckData.Identity.Builder countryOfCitizenship(String countryOfCitizenship)

  Nationality of the applicant.

• countryOfCitizenship

   final UsKycCheckData.Identity.Builder countryOfCitizenship(JsonField<String> countryOfCitizenship)

  Sets Builder.countryOfCitizenship to an arbitrary JSON value.

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

• countryOfTaxResidence

   final UsKycCheckData.Identity.Builder countryOfTaxResidence(UsKycCheckData.Identity.CountryOfTaxResidence countryOfTaxResidence)

  Country of residency of the applicant. Must be 'US'.

• countryOfTaxResidence

   final UsKycCheckData.Identity.Builder countryOfTaxResidence(JsonField<UsKycCheckData.Identity.CountryOfTaxResidence> countryOfTaxResidence)

  Sets Builder.countryOfTaxResidence to an arbitrary JSON value.

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

• dateOfBirth

   final UsKycCheckData.Identity.Builder dateOfBirth(LocalDate dateOfBirth)

  Date of birth of the applicant.

• dateOfBirth

   final UsKycCheckData.Identity.Builder dateOfBirth(JsonField<LocalDate> dateOfBirth)

  Sets Builder.dateOfBirth to an arbitrary JSON value.

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

• emailAddress

   final UsKycCheckData.Identity.Builder emailAddress(String emailAddress)

  Email address of the applicant.

• emailAddress

   final UsKycCheckData.Identity.Builder emailAddress(JsonField<String> emailAddress)

  Sets Builder.emailAddress to an arbitrary JSON value.

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

• familyName

   final UsKycCheckData.Identity.Builder familyName(String familyName)

  The last name (surname) of the user.

• familyName

   final UsKycCheckData.Identity.Builder familyName(JsonField<String> familyName)

  Sets Builder.familyName to an arbitrary JSON value.

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

• givenName

   final UsKycCheckData.Identity.Builder givenName(String givenName)

  The first/given name of the user.

• givenName

   final UsKycCheckData.Identity.Builder givenName(JsonField<String> givenName)

  Sets Builder.givenName to an arbitrary JSON value.

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

• phoneNumber

   final UsKycCheckData.Identity.Builder phoneNumber(String phoneNumber)

  Phone number should include the country code, format: “+15555555555”

• phoneNumber

   final UsKycCheckData.Identity.Builder phoneNumber(JsonField<String> phoneNumber)

  Sets Builder.phoneNumber to an arbitrary JSON value.

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

• postalCode

   final UsKycCheckData.Identity.Builder postalCode(String postalCode)

  Postal code of the applicant.

• postalCode

   final UsKycCheckData.Identity.Builder postalCode(JsonField<String> postalCode)

  Sets Builder.postalCode to an arbitrary JSON value.

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

• streetAddress

   final UsKycCheckData.Identity.Builder streetAddress(String streetAddress)

  Street address of the applicant.

• streetAddress

   final UsKycCheckData.Identity.Builder streetAddress(JsonField<String> streetAddress)

  Sets Builder.streetAddress to an arbitrary JSON value.

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

• taxId

   final UsKycCheckData.Identity.Builder taxId(String taxId)

  Social Security Number (SSN) or Tax Identification Number (TIN) of the applicant.

• taxId

   final UsKycCheckData.Identity.Builder taxId(JsonField<String> taxId)

  Sets Builder.taxId to an arbitrary JSON value.

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

• middleName

   final UsKycCheckData.Identity.Builder middleName(String middleName)

  The middle name of the user.

• middleName

   final UsKycCheckData.Identity.Builder middleName(Optional<String> middleName)

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

• middleName

   final UsKycCheckData.Identity.Builder middleName(JsonField<String> middleName)

  Sets Builder.middleName to an arbitrary JSON value.

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

• state

   final UsKycCheckData.Identity.Builder state(String state)

  State of the applicant. Required if the applicant resides in the US as a 2-letter abbreviation.

• state

   final UsKycCheckData.Identity.Builder state(Optional<String> state)

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

• state

   final UsKycCheckData.Identity.Builder state(JsonField<String> state)

  Sets Builder.state to an arbitrary JSON value.

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

• unit

   final UsKycCheckData.Identity.Builder unit(String unit)

  The specific apartment number if applicable

• unit

   final UsKycCheckData.Identity.Builder unit(Optional<String> unit)

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

• unit

   final UsKycCheckData.Identity.Builder unit(JsonField<String> unit)

  Sets Builder.unit to an arbitrary JSON value.

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

• additionalProperties

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

• putAdditionalProperty

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

• putAllAdditionalProperties

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

• removeAdditionalProperty

   final UsKycCheckData.Identity.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

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

• build

   final UsKycCheckData.Identity build()

  Returns an immutable instance of Identity.

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

  The following fields are required:

  .city()
  .countryOfCitizenship()
  .countryOfTaxResidence()
  .dateOfBirth()
  .emailAddress()
  .familyName()
  .givenName()
  .phoneNumber()
  .postalCode()
  .streetAddress()
  .taxId()