java.lang.Object
- Avalara.SDK.model.A1099.V2.W8BenEFormRequest

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.7.0")
public class W8BenEFormRequest
extends Object

W8BenEFormRequest

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`W8BenEFormRequest.CustomTypeAdapterFactory`
`static class`	`W8BenEFormRequest.TypeEnum`	The form type (always \"w8bene\" for this model).

Field Summary

Fields
Modifier and Type	Field	Description
`static HashSet<String>`	`openapiFields`
`static HashSet<String>`	`openapiRequiredFields`
`static String`	`SERIALIZED_NAME_ACTIVE_NFFE_CERTIFICATION`
`static String`	`SERIALIZED_NAME_BENEFIT_LIMITATION`
`static String`	`SERIALIZED_NAME_BENEFIT_LIMITATION_CERTIFICATION`
`static String`	`SERIALIZED_NAME_CAPACITY_TO_SIGN_CERTIFICATION`
`static String`	`SERIALIZED_NAME_CITIZENSHIP_COUNTRY`
`static String`	`SERIALIZED_NAME_COMPANY_ID`
`static String`	`SERIALIZED_NAME_COMPLIANT_FFI_LOW_VALUE_ACCOUNTS_CERTIFICATION`
`static String`	`SERIALIZED_NAME_COMPLIANT_LIMITED_LIFE_DEBT_ENTITY_CERTIFICATION`
`static String`	`SERIALIZED_NAME_COMPLIANT_NONREGISTERING_LOCAL_BANK_CERTIFICATION`
`static String`	`SERIALIZED_NAME_CONTROLLED_FOREIGN_CORPORATION_CERTIFICATION`
`static String`	`SERIALIZED_NAME_DETERMINATION_LETTER_DATE`
`static String`	`SERIALIZED_NAME_DIRECT_REPORTING_NFFE_SPONSORING_ENTITY`
`static String`	`SERIALIZED_NAME_DISREGARDED_ADDRESS`
`static String`	`SERIALIZED_NAME_DISREGARDED_CITY`
`static String`	`SERIALIZED_NAME_DISREGARDED_COUNTRY`
`static String`	`SERIALIZED_NAME_DISREGARDED_ENTITY`
`static String`	`SERIALIZED_NAME_DISREGARDED_ENTITY_FATCA_STATUS`
`static String`	`SERIALIZED_NAME_DISREGARDED_ENTITY_GIIN`
`static String`	`SERIALIZED_NAME_DISREGARDED_STATE`
`static String`	`SERIALIZED_NAME_DISREGARDED_ZIP`
`static String`	`SERIALIZED_NAME_E_DELIVERY_CONSENTED_AT`
`static String`	`SERIALIZED_NAME_EMAIL`
`static String`	`SERIALIZED_NAME_ENTITY_TYPE`
`static String`	`SERIALIZED_NAME_EXCEPTED_INTER_AFFILIATE_FFI_CERTIFICATION`
`static String`	`SERIALIZED_NAME_EXCEPTED_NONFINANCIAL_ENTITY_IN_LIQUIDATION_OR_BANKRUPTCY_CERTIFICATION`
`static String`	`SERIALIZED_NAME_EXCEPTED_NONFINANCIAL_GROUP_ENTITY_CERTIFICATION`
`static String`	`SERIALIZED_NAME_EXCEPTED_NONFINANCIAL_START_UP_CERTIFICATION`
`static String`	`SERIALIZED_NAME_EXCEPTED_TERRITORY_NFFE_CERTIFICATION`
`static String`	`SERIALIZED_NAME_EXEMPT_BENEFICIAL_OWNER_OWNED_INVESTMENT_ENTITY_CERTIFICATION`
`static String`	`SERIALIZED_NAME_EXEMPT_BENEFICIAL_OWNER_SPONSORED_RETIREMENT_FUND_CERTIFICATION`
`static String`	`SERIALIZED_NAME_FATCA_STATUS`
`static String`	`SERIALIZED_NAME_FFI_SPONSORING_ENTITY`
`static String`	`SERIALIZED_NAME_FOREIGN_TIN`
`static String`	`SERIALIZED_NAME_FOREIGN_TIN_NOT_REQUIRED`
`static String`	`SERIALIZED_NAME_GIIN`
`static String`	`SERIALIZED_NAME_IGA_COUNTRY`
`static String`	`SERIALIZED_NAME_IGA_FFI_TRUSTEE_IS_FOREIGN`
`static String`	`SERIALIZED_NAME_IGA_FFI_TRUSTEE_OR_SPONSOR`
`static String`	`SERIALIZED_NAME_IGA_LEGAL_STATUS_TREATMENT`
`static String`	`SERIALIZED_NAME_IGA_MODEL`
`static String`	`SERIALIZED_NAME_INCOME_TYPE`
`static String`	`SERIALIZED_NAME_INTERGOVERNMENTAL_ORGANIZATION_CERTIFICATION`
`static String`	`SERIALIZED_NAME_INTERNATION_ORGANIZATION_CERTIFICATION`
`static String`	`SERIALIZED_NAME_INVESTMENT_ENTITY_CERTIFICATION`
`static String`	`SERIALIZED_NAME_INVESTMENT_ENTITY_FOR_RETIREMENT_FUNDS_CERTIFICATION`
`static String`	`SERIALIZED_NAME_INVESTMENT_ENTITY_NO_FINANCIAL_ACCOUNTS_CERTIFICATION`
`static String`	`SERIALIZED_NAME_MAILING_ADDRESS`
`static String`	`SERIALIZED_NAME_MAILING_CITY`
`static String`	`SERIALIZED_NAME_MAILING_COUNTRY`
`static String`	`SERIALIZED_NAME_MAILING_STATE`
`static String`	`SERIALIZED_NAME_MAILING_ZIP`
`static String`	`SERIALIZED_NAME_MAKING_TREATY_CLAIM`
`static String`	`SERIALIZED_NAME_NAME`
`static String`	`SERIALIZED_NAME_NARROW_PARTICIPATION_RETIREMENT_FUND_CERTIFICATION`
`static String`	`SERIALIZED_NAME_NFFE_AFFILIATE_OF_PUBLICLY_TRADED_ENTITY_CERTIFICATION`
`static String`	`SERIALIZED_NAME_NFFE_AFFILIATE_OF_PUBLICLY_TRADED_ENTITY_SECURITIES_MARKET`
`static String`	`SERIALIZED_NAME_NON_COMMERCIAL_FINANCIAL_ACTIVITY_CERTIFICATION`
`static String`	`SERIALIZED_NAME_NONFINANCIAL_ENTITY_FILING_DATE`
`static String`	`SERIALIZED_NAME_NONPROFIT_ORGANIZATION_CERTIFICATION`
`static String`	`SERIALIZED_NAME_NONREPORTING_IGA_FFI_CERTIFICATION`
`static String`	`SERIALIZED_NAME_OWNER_DOCUMENTED_FFI_AUDITOR_LETTER_CERTIFICATION`
`static String`	`SERIALIZED_NAME_OWNER_DOCUMENTED_FFI_CERTIFICATION`
`static String`	`SERIALIZED_NAME_OWNER_DOCUMENTED_FFI_REPORTING_STATEMENT_CERTIFICATION`
`static String`	`SERIALIZED_NAME_OWNER_DOCUMENTED_FFI_TRUST_BENEFICIARIES_CERTIFICATION`
`static String`	`SERIALIZED_NAME_PASSIVE_NFFE_CERTIFICATION`
`static String`	`SERIALIZED_NAME_PASSIVE_NFFE_NO_SUBSTANTIAL_US_OWNERS_CERTIFICATION`
`static String`	`SERIALIZED_NAME_PASSIVE_NFFE_SUBSTANTIAL_US_OWNERS_PROVIDED_CERTIFICATION`
`static String`	`SERIALIZED_NAME_PUBLICLY_TRADED_ENTITY`
`static String`	`SERIALIZED_NAME_PUBLICLY_TRADED_NFFE_CERTIFICATION`
`static String`	`SERIALIZED_NAME_PUBLICLY_TRADED_NFFE_SECURITIES_MARKET`
`static String`	`SERIALIZED_NAME_QUALIFIED_RESIDENT_STATUS_CERTIFICATION`
`static String`	`SERIALIZED_NAME_QUALIFIED_RETIREMENT_FUND_CERTIFICATION`
`static String`	`SERIALIZED_NAME_REFERENCE_ID`
`static String`	`SERIALIZED_NAME_REFERENCE_NUMBER`
`static String`	`SERIALIZED_NAME_RESIDENCE_ADDRESS`
`static String`	`SERIALIZED_NAME_RESIDENCE_CITY`
`static String`	`SERIALIZED_NAME_RESIDENCE_COUNTRY`
`static String`	`SERIALIZED_NAME_RESIDENCE_IS_MAILING`
`static String`	`SERIALIZED_NAME_RESIDENCE_STATE`
`static String`	`SERIALIZED_NAME_RESIDENCE_ZIP`
`static String`	`SERIALIZED_NAME_RESTRICTED_DISTRIBUTOR_AGREEMENT_CERTIFICATION`
`static String`	`SERIALIZED_NAME_RESTRICTED_DISTRIBUTOR_CERTIFICATION`
`static String`	`SERIALIZED_NAME_RESTRICTED_DISTRIBUTOR_PREEXISTING_SALES_COMPLIANCE_CERTIFICATION`
`static String`	`SERIALIZED_NAME_SECTION401_A_EQUIVALENT_PENSION_PLAN_CERTIFICATION`
`static String`	`SERIALIZED_NAME_SECTION501_C_ORGANIZATION_CERTIFICATION`
`static String`	`SERIALIZED_NAME_SIGNATURE`
`static String`	`SERIALIZED_NAME_SIGNER_NAME`
`static String`	`SERIALIZED_NAME_SPONSORED_CLOSELY_HELD_ENTITY_SPONSORING_ENTITY`
`static String`	`SERIALIZED_NAME_SPONSORED_CLOSELY_HELD_INVESTMENT_VEHICLE_CERTIFICATION`
`static String`	`SERIALIZED_NAME_SPONSORED_DIRECT_REPORTING_NFFE_CERTIFICATION`
`static String`	`SERIALIZED_NAME_STARTUP_FORMATION_OR_RESOLUTION_DATE`
`static String`	`SERIALIZED_NAME_SUBSTANTIAL_US_OWNERS`
`static String`	`SERIALIZED_NAME_TERRITORY_FINANCIAL_INSTITUTION_CERTIFICATION`
`static String`	`SERIALIZED_NAME_TIN`
`static String`	`SERIALIZED_NAME_TREATY_ARTICLE`
`static String`	`SERIALIZED_NAME_TREATY_COUNTRY`
`static String`	`SERIALIZED_NAME_TREATY_COUNTRY_CERTIFICATION`
`static String`	`SERIALIZED_NAME_TREATY_QUALIFIED_PENSION_FUND_CERTIFICATION`
`static String`	`SERIALIZED_NAME_TREATY_REASONS`
`static String`	`SERIALIZED_NAME_TYPE`
`static String`	`SERIALIZED_NAME_WITHHOLDING_RATE`

Constructor Summary

Constructors
Constructor Description

W8BenEFormRequest()

W8BenEFormRequest(W8BenEFormRequest.TypeEnum type)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`W8BenEFormRequest`	`activeNffeCertification(Boolean activeNffeCertification)`
`W8BenEFormRequest`	`addSubstantialUsOwnersItem(SubstantialUsOwnerRequest substantialUsOwnersItem)`
`W8BenEFormRequest`	`benefitLimitation(String benefitLimitation)`
`W8BenEFormRequest`	`benefitLimitationCertification(Boolean benefitLimitationCertification)`
`W8BenEFormRequest`	`capacityToSignCertification(Boolean capacityToSignCertification)`
`W8BenEFormRequest`	`citizenshipCountry(String citizenshipCountry)`
`W8BenEFormRequest`	`companyId(String companyId)`
`W8BenEFormRequest`	`compliantFfiLowValueAccountsCertification(Boolean compliantFfiLowValueAccountsCertification)`
`W8BenEFormRequest`	`compliantLimitedLifeDebtEntityCertification(Boolean compliantLimitedLifeDebtEntityCertification)`
`W8BenEFormRequest`	`compliantNonregisteringLocalBankCertification(Boolean compliantNonregisteringLocalBankCertification)`
`W8BenEFormRequest`	`controlledForeignCorporationCertification(Boolean controlledForeignCorporationCertification)`
`W8BenEFormRequest`	`determinationLetterDate(LocalDate determinationLetterDate)`
`W8BenEFormRequest`	`directReportingNffeSponsoringEntity(String directReportingNffeSponsoringEntity)`
`W8BenEFormRequest`	`disregardedAddress(String disregardedAddress)`
`W8BenEFormRequest`	`disregardedCity(String disregardedCity)`
`W8BenEFormRequest`	`disregardedCountry(String disregardedCountry)`
`W8BenEFormRequest`	`disregardedEntity(String disregardedEntity)`
`W8BenEFormRequest`	`disregardedEntityFatcaStatus(String disregardedEntityFatcaStatus)`
`W8BenEFormRequest`	`disregardedEntityGiin(String disregardedEntityGiin)`
`W8BenEFormRequest`	`disregardedState(String disregardedState)`
`W8BenEFormRequest`	`disregardedZip(String disregardedZip)`
`W8BenEFormRequest`	`eDeliveryConsentedAt(OffsetDateTime eDeliveryConsentedAt)`
`W8BenEFormRequest`	`email(String email)`
`W8BenEFormRequest`	`entityType(String entityType)`
`boolean`	`equals(Object o)`
`W8BenEFormRequest`	`exceptedInterAffiliateFfiCertification(Boolean exceptedInterAffiliateFfiCertification)`
`W8BenEFormRequest`	`exceptedNonfinancialEntityInLiquidationOrBankruptcyCertification(Boolean exceptedNonfinancialEntityInLiquidationOrBankruptcyCertification)`
`W8BenEFormRequest`	`exceptedNonfinancialGroupEntityCertification(Boolean exceptedNonfinancialGroupEntityCertification)`
`W8BenEFormRequest`	`exceptedNonfinancialStartUpCertification(Boolean exceptedNonfinancialStartUpCertification)`
`W8BenEFormRequest`	`exceptedTerritoryNffeCertification(Boolean exceptedTerritoryNffeCertification)`
`W8BenEFormRequest`	`exemptBeneficialOwnerOwnedInvestmentEntityCertification(Boolean exemptBeneficialOwnerOwnedInvestmentEntityCertification)`
`W8BenEFormRequest`	`exemptBeneficialOwnerSponsoredRetirementFundCertification(Boolean exemptBeneficialOwnerSponsoredRetirementFundCertification)`
`W8BenEFormRequest`	`fatcaStatus(String fatcaStatus)`
`W8BenEFormRequest`	`ffiSponsoringEntity(String ffiSponsoringEntity)`
`W8BenEFormRequest`	`foreignTin(String foreignTin)`
`W8BenEFormRequest`	`foreignTinNotRequired(Boolean foreignTinNotRequired)`
`static W8BenEFormRequest`	`fromJson(String jsonString)`	Create an instance of W8BenEFormRequest given an JSON string
`Boolean`	`getActiveNffeCertification()`	Certifies that the entity is a foreign non-financial institution with less than 50% passive income and less than 50% of its assets producing or held to produce passive income.
`String`	`getBenefitLimitation()`	The benefit limitation for tax treaty claims.
`Boolean`	`getBenefitLimitationCertification()`	Certifies that the beneficial owner is eligible for treaty benefits and meets any limitation on benefits requirements.
`Boolean`	`getCapacityToSignCertification()`	Certifies signer has the capacity to sign for the beneficial owner.
`String`	`getCitizenshipCountry()`	The country of citizenship.
`String`	`getCompanyId()`	The ID of the associated company.
`Boolean`	`getCompliantFfiLowValueAccountsCertification()`	Certifies that the FFI is not primarily engaged in investment activities, maintains only low-value accounts, and has limited total assets within its group.
`Boolean`	`getCompliantLimitedLifeDebtEntityCertification()`	Certifies that the entity qualifies as a limited life debt investment entity based on its formation date, issuance terms, and compliance with regulatory requirements.
`Boolean`	`getCompliantNonregisteringLocalBankCertification()`	Certifies that the FFI operates solely as a limited bank or credit union within its country, meets asset thresholds, and has no foreign operations or affiliations outside its country of organization.
`Boolean`	`getControlledForeignCorporationCertification()`	Certifies that the entity is a controlled foreign corporation sponsored by a U.S.
`LocalDate`	`getDeterminationLetterDate()`	The date of the IRS determination letter confirming the entity’s section 501(c) status.
`String`	`getDirectReportingNffeSponsoringEntity()`	The name of the entity that sponsors the direct reporting NFFE.
`String`	`getDisregardedAddress()`	The address for disregarded entities.
`String`	`getDisregardedCity()`	The city for disregarded entities.
`String`	`getDisregardedCountry()`	The country for disregarded entities.
`String`	`getDisregardedEntity()`	The name of the disregarded entity receiving the payment (if applicable).
`String`	`getDisregardedEntityFatcaStatus()`	The FATCA status of disregarded entity or branch receiving payment.
`String`	`getDisregardedEntityGiin()`	The GIIN for disregarded entities.
`String`	`getDisregardedState()`	The state for disregarded entities.
`String`	`getDisregardedZip()`	The ZIP code for disregarded entities.
`OffsetDateTime`	`geteDeliveryConsentedAt()`	The date when e-delivery was consented.
`String`	`getEmail()`	The email address of the individual associated with the form.
`String`	`getEntityType()`	The entity type.
`Boolean`	`getExceptedInterAffiliateFfiCertification()`	Certifies that the entity is an inter-affiliate FFI meeting all conditions for exemption, including limited account activity and payment interactions within its expanded affiliated group.
`Boolean`	`getExceptedNonfinancialEntityInLiquidationOrBankruptcyCertification()`	Certifies that the entity is in liquidation, reorganization, or bankruptcy and intends to operate as a nonfinancial entity, with supporting documentation available if the process exceeds three years.
`Boolean`	`getExceptedNonfinancialGroupEntityCertification()`	Certifies that the entity is a holding company, treasury center, or captive finance company operating within a nonfinancial group and not functioning as an investment or financial institution.
`Boolean`	`getExceptedNonfinancialStartUpCertification()`	Certifies that the entity is a recently formed startup NFFE investing in a non-financial business and is not operating as or presenting itself as an investment fund.
`Boolean`	`getExceptedTerritoryNffeCertification()`	Certifies that the entity is organized in a U.S.
`Boolean`	`getExemptBeneficialOwnerOwnedInvestmentEntityCertification()`	Certifies that the entity is an investment entity wholly owned by exempt beneficial owners and has provided complete ownership and documentation details as required under FATCA regulations.
`Boolean`	`getExemptBeneficialOwnerSponsoredRetirementFundCertification()`	Certifies that the entity is established and sponsored by a qualifying exempt beneficial owner to provide retirement, disability, or death benefits to individuals based on services performed for the sponsor.
`String`	`getFatcaStatus()`	The FATCA status.
`String`	`getFfiSponsoringEntity()`	The name of the entity that sponsors the foreign financial institution (FFI).
`String`	`getForeignTin()`	The foreign taxpayer identification number (TIN).
`Boolean`	`getForeignTinNotRequired()`	Indicates whether a foreign TIN is not required.
`String`	`getGiin()`	The global intermediary identification number (GIIN).
`String`	`getIgaCountry()`	The country for the applicable IGA with the United States.
`Boolean`	`getIgaFfiTrusteeIsForeign()`	Indicates whether the trustee for the nonreporting IGA FFI is foreign.
`String`	`getIgaFfiTrusteeOrSponsor()`	The trustee or sponsor name for the nonreporting IGA FFI.
`String`	`getIgaLegalStatusTreatment()`	Specifies how the applicable IGA is treated under the IGA provisions or Treasury regulations.
`String`	`getIgaModel()`	The applicable IGA model.
`String`	`getIncomeType()`	Specifies the type of income for which the reduced treaty withholding rate is being claimed.
`Boolean`	`getIntergovernmentalOrganizationCertification()`	Certifies that the entity is an intergovernmental or supranational organization primarily comprised of foreign governments, is the beneficial owner, and is not engaged in commercial financial activities.
`Boolean`	`getInternationOrganizationCertification()`	Certifies that the entity is an international organization described in section 7701(a)(18).
`Boolean`	`getInvestmentEntityCertification()`	Certifies that the entity is an investment entity, not a QI, WP, or WT, and has an agreement with a sponsoring entity.
`Boolean`	`getInvestmentEntityForRetirementFundsCertification()`	Certifies that the entity is established solely to earn income for the benefit of qualifying retirement funds or accounts under applicable FATCA regulations or IGAs.
`Boolean`	`getInvestmentEntityNoFinancialAccountsCertification()`	Certifies that the entity is a financial institution solely because it is an investment entity under regulations and the entity does not maintain financial accounts.
`String`	`getMailingAddress()`	The mailing address.
`String`	`getMailingCity()`	The city of the mailing address.
`String`	`getMailingCountry()`	The country of the mailing address.
`String`	`getMailingState()`	The state of the mailing address.
`String`	`getMailingZip()`	The ZIP code of the mailing address.
`Boolean`	`getMakingTreatyClaim()`	Indicates whether the entity is making a treaty claim.
`String`	`getName()`	The name of the individual or entity associated with the form.
`Boolean`	`getNarrowParticipationRetirementFundCertification()`	Certifies that the entity is a government-regulated retirement fund with fewer than 50 participants, limited foreign ownership, and employer sponsorship that is not from investment entities or passive NFFEs.
`Boolean`	`getNffeAffiliateOfPubliclyTradedEntityCertification()`	Certifies that the entity is a foreign corporation that is not a financial institution and is affiliated with a publicly traded entity within the same expanded affiliated group.
`String`	`getNffeAffiliateOfPubliclyTradedEntitySecuritiesMarket()`	The name of the established securities market where the affiliated entity's stock is traded.
`Boolean`	`getNonCommercialFinancialActivityCertification()`	Certifies that the entity is the beneficial owner and is not engaged in commercial financial activities related to the specified payments, accounts or obligations for which this form is submitted.
`LocalDate`	`getNonfinancialEntityFilingDate()`	The filed date for a plan of reorganization, liquidation or bankruptcy.
`Boolean`	`getNonprofitOrganizationCertification()`	Certifies that the entity is a nonprofit organization established for charitable or similar purposes, exempt from income tax, and restricted in the use and distribution of its assets under applicable law.
`Boolean`	`getNonreportingIgaFfiCertification()`	Certifies that the entity meets the requirements to be considered a nonreporting financial institution to an applicable IGA.
`Boolean`	`getOwnerDocumentedFfiAuditorLetterCertification()`	Certifies that the FFI will provide an auditor’s letter and required owner reporting documentation to confirm its status as an owner-documented FFI.
`Boolean`	`getOwnerDocumentedFfiCertification()`	Certifies that the FFI meets all requirements to qualify as an owner-documented FFI, including restrictions on activities, ownership, and account relationships.
`Boolean`	`getOwnerDocumentedFfiReportingStatementCertification()`	Certifies that the FFI will provide a complete owner reporting statement and required documentation for each relevant owner or debt holder.
`Boolean`	`getOwnerDocumentedFfiTrustBeneficiariesCertification()`	Certifies that the trust has no contingent or unidentified beneficiaries or designated classes of beneficiaries.
`Boolean`	`getPassiveNffeCertification()`	Certifies that the entity is a foreign non-financial entity that does not qualify for any other NFFE category and is not a financial institution.
`Boolean`	`getPassiveNffeNoSubstantialUsOwnersCertification()`	Certifies that the passive NFFE has no substantial U.S.
`Boolean`	`getPassiveNffeSubstantialUsOwnersProvidedCertification()`	Certifies that the passive NFFE has provided the name, address, and TIN of each substantial U.S.
`String`	`getPubliclyTradedEntity()`	The name of the affiliated entity whose stock is regularly traded on an established securities market.
`Boolean`	`getPubliclyTradedNffeCertification()`	Certifies that the entity is a foreign corporation that is not a financial institution and whose stock is regularly traded on an established securities market.
`String`	`getPubliclyTradedNffeSecuritiesMarket()`	The name of the securities market where the corporation's stock is regularly traded.
`Boolean`	`getQualifiedResidentStatusCertification()`	Certifies that the beneficial owner claims treaty benefits and meets the qualified resident status for specific U.S.
`Boolean`	`getQualifiedRetirementFundCertification()`	Certifies that the entity is a government-regulated retirement fund meeting specific requirements for contributions, tax exemption, beneficiary limits, and distribution restrictions.
`String`	`getReferenceId()`	A reference identifier for the form.
`String`	`getReferenceNumber()`	A reference number for the form.
`String`	`getResidenceAddress()`	The residential address of the individual or entity.
`String`	`getResidenceCity()`	The city of residence.
`String`	`getResidenceCountry()`	The country of residence.
`Boolean`	`getResidenceIsMailing()`	Indicates whether the residence address is also the mailing address.
`String`	`getResidenceState()`	The state of residence.
`String`	`getResidenceZip()`	The ZIP code of the residence.
`Boolean`	`getRestrictedDistributorAgreementCertification()`	Certifies that the entity is, and has been, bound by distribution agreements prohibiting sales of fund interests to specified U.S.
`Boolean`	`getRestrictedDistributorCertification()`	Certifies that the entity qualifies as a restricted distributor based on its operations, customer base, regulatory compliance, and financial and geographic limitations.
`Boolean`	`getRestrictedDistributorPreexistingSalesComplianceCertification()`	Certifies that the entity complies with distribution restrictions for U.S.-linked investors and has addressed any preexisting sales in accordance with FATCA regulations.
`Boolean`	`getSection401AEquivalentPensionPlanCertification()`	Certifies that the entity is formed under a pension plan meeting section 401(a) requirements, except for being U.S.-trust funded.
`Boolean`	`getSection501COrganizationCertification()`	Certifies that the entity is a section 501(c) organization based on a valid IRS determination letter or a legal opinion from U.S.
`String`	`getSignature()`	The signature of the form.
`String`	`getSignerName()`	The name of the signer.
`String`	`getSponsoredCloselyHeldEntitySponsoringEntity()`	The name of sponsoring entity for a certified deemed-compliant, closely held investment vehicle.
`Boolean`	`getSponsoredCloselyHeldInvestmentVehicleCertification()`	Certifies that the entity is a sponsored investment entity with 20 or fewer individual owners, and that all compliance obligations are fulfilled by the sponsoring entity.
`Boolean`	`getSponsoredDirectReportingNffeCertification()`	Certifies that the entity is a sponsored direct reporting NFFE.
`LocalDate`	`getStartupFormationOrResolutionDate()`	The date the start-up company was formed on (or, in case of new line of business, the date of board resolution approving the new line of business).
`List<SubstantialUsOwnerRequest>`	`getSubstantialUsOwners()`	The list of substantial U.S.
`Boolean`	`getTerritoryFinancialInstitutionCertification()`	Certifies that the entity is a financial institution (other than an investment entity) that is incorporated or organized under the laws of a possession of the United States.
`String`	`getTin()`	The taxpayer identification number (TIN).
`String`	`getTreatyArticle()`	Indicates the specific article and paragraph of the tax treaty under which the beneficial owner is claiming benefits.
`String`	`getTreatyCountry()`	The treaty country of the beneficial owner.
`Boolean`	`getTreatyCountryCertification()`	Certifies the beneficial owner's country under the U.S.
`Boolean`	`getTreatyQualifiedPensionFundCertification()`	Certifies that the entity is a pension or retirement fund established in a treaty country and is entitled to treaty benefits on U.S.
`String`	`getTreatyReasons()`	The additional conditions in the article the beneficial owner meets to be eligible for the rate of withholding.
`W8BenEFormRequest.TypeEnum`	`getType()`	The form type (always \"w8bene\" for this model).
`String`	`getWithholdingRate()`	Specifies the reduced withholding rate claimed under the applicable tax treaty.
`W8BenEFormRequest`	`giin(String giin)`
`int`	`hashCode()`
`W8BenEFormRequest`	`igaCountry(String igaCountry)`
`W8BenEFormRequest`	`igaFfiTrusteeIsForeign(Boolean igaFfiTrusteeIsForeign)`
`W8BenEFormRequest`	`igaFfiTrusteeOrSponsor(String igaFfiTrusteeOrSponsor)`
`W8BenEFormRequest`	`igaLegalStatusTreatment(String igaLegalStatusTreatment)`
`W8BenEFormRequest`	`igaModel(String igaModel)`
`W8BenEFormRequest`	`incomeType(String incomeType)`
`W8BenEFormRequest`	`intergovernmentalOrganizationCertification(Boolean intergovernmentalOrganizationCertification)`
`W8BenEFormRequest`	`internationOrganizationCertification(Boolean internationOrganizationCertification)`
`W8BenEFormRequest`	`investmentEntityCertification(Boolean investmentEntityCertification)`
`W8BenEFormRequest`	`investmentEntityForRetirementFundsCertification(Boolean investmentEntityForRetirementFundsCertification)`
`W8BenEFormRequest`	`investmentEntityNoFinancialAccountsCertification(Boolean investmentEntityNoFinancialAccountsCertification)`
`W8BenEFormRequest`	`mailingAddress(String mailingAddress)`
`W8BenEFormRequest`	`mailingCity(String mailingCity)`
`W8BenEFormRequest`	`mailingCountry(String mailingCountry)`
`W8BenEFormRequest`	`mailingState(String mailingState)`
`W8BenEFormRequest`	`mailingZip(String mailingZip)`
`W8BenEFormRequest`	`makingTreatyClaim(Boolean makingTreatyClaim)`
`W8BenEFormRequest`	`name(String name)`
`W8BenEFormRequest`	`narrowParticipationRetirementFundCertification(Boolean narrowParticipationRetirementFundCertification)`
`W8BenEFormRequest`	`nffeAffiliateOfPubliclyTradedEntityCertification(Boolean nffeAffiliateOfPubliclyTradedEntityCertification)`
`W8BenEFormRequest`	`nffeAffiliateOfPubliclyTradedEntitySecuritiesMarket(String nffeAffiliateOfPubliclyTradedEntitySecuritiesMarket)`
`W8BenEFormRequest`	`nonCommercialFinancialActivityCertification(Boolean nonCommercialFinancialActivityCertification)`
`W8BenEFormRequest`	`nonfinancialEntityFilingDate(LocalDate nonfinancialEntityFilingDate)`
`W8BenEFormRequest`	`nonprofitOrganizationCertification(Boolean nonprofitOrganizationCertification)`
`W8BenEFormRequest`	`nonreportingIgaFfiCertification(Boolean nonreportingIgaFfiCertification)`
`W8BenEFormRequest`	`ownerDocumentedFfiAuditorLetterCertification(Boolean ownerDocumentedFfiAuditorLetterCertification)`
`W8BenEFormRequest`	`ownerDocumentedFfiCertification(Boolean ownerDocumentedFfiCertification)`
`W8BenEFormRequest`	`ownerDocumentedFfiReportingStatementCertification(Boolean ownerDocumentedFfiReportingStatementCertification)`
`W8BenEFormRequest`	`ownerDocumentedFfiTrustBeneficiariesCertification(Boolean ownerDocumentedFfiTrustBeneficiariesCertification)`
`W8BenEFormRequest`	`passiveNffeCertification(Boolean passiveNffeCertification)`
`W8BenEFormRequest`	`passiveNffeNoSubstantialUsOwnersCertification(Boolean passiveNffeNoSubstantialUsOwnersCertification)`
`W8BenEFormRequest`	`passiveNffeSubstantialUsOwnersProvidedCertification(Boolean passiveNffeSubstantialUsOwnersProvidedCertification)`
`W8BenEFormRequest`	`publiclyTradedEntity(String publiclyTradedEntity)`
`W8BenEFormRequest`	`publiclyTradedNffeCertification(Boolean publiclyTradedNffeCertification)`
`W8BenEFormRequest`	`publiclyTradedNffeSecuritiesMarket(String publiclyTradedNffeSecuritiesMarket)`
`W8BenEFormRequest`	`qualifiedResidentStatusCertification(Boolean qualifiedResidentStatusCertification)`
`W8BenEFormRequest`	`qualifiedRetirementFundCertification(Boolean qualifiedRetirementFundCertification)`
`W8BenEFormRequest`	`referenceId(String referenceId)`
`W8BenEFormRequest`	`referenceNumber(String referenceNumber)`
`W8BenEFormRequest`	`residenceAddress(String residenceAddress)`
`W8BenEFormRequest`	`residenceCity(String residenceCity)`
`W8BenEFormRequest`	`residenceCountry(String residenceCountry)`
`W8BenEFormRequest`	`residenceIsMailing(Boolean residenceIsMailing)`
`W8BenEFormRequest`	`residenceState(String residenceState)`
`W8BenEFormRequest`	`residenceZip(String residenceZip)`
`W8BenEFormRequest`	`restrictedDistributorAgreementCertification(Boolean restrictedDistributorAgreementCertification)`
`W8BenEFormRequest`	`restrictedDistributorCertification(Boolean restrictedDistributorCertification)`
`W8BenEFormRequest`	`restrictedDistributorPreexistingSalesComplianceCertification(Boolean restrictedDistributorPreexistingSalesComplianceCertification)`
`W8BenEFormRequest`	`section401AEquivalentPensionPlanCertification(Boolean section401AEquivalentPensionPlanCertification)`
`W8BenEFormRequest`	`section501COrganizationCertification(Boolean section501COrganizationCertification)`
`void`	`setActiveNffeCertification(Boolean activeNffeCertification)`
`void`	`setBenefitLimitation(String benefitLimitation)`
`void`	`setBenefitLimitationCertification(Boolean benefitLimitationCertification)`
`void`	`setCapacityToSignCertification(Boolean capacityToSignCertification)`
`void`	`setCitizenshipCountry(String citizenshipCountry)`
`void`	`setCompanyId(String companyId)`
`void`	`setCompliantFfiLowValueAccountsCertification(Boolean compliantFfiLowValueAccountsCertification)`
`void`	`setCompliantLimitedLifeDebtEntityCertification(Boolean compliantLimitedLifeDebtEntityCertification)`
`void`	`setCompliantNonregisteringLocalBankCertification(Boolean compliantNonregisteringLocalBankCertification)`
`void`	`setControlledForeignCorporationCertification(Boolean controlledForeignCorporationCertification)`
`void`	`setDeterminationLetterDate(LocalDate determinationLetterDate)`
`void`	`setDirectReportingNffeSponsoringEntity(String directReportingNffeSponsoringEntity)`
`void`	`setDisregardedAddress(String disregardedAddress)`
`void`	`setDisregardedCity(String disregardedCity)`
`void`	`setDisregardedCountry(String disregardedCountry)`
`void`	`setDisregardedEntity(String disregardedEntity)`
`void`	`setDisregardedEntityFatcaStatus(String disregardedEntityFatcaStatus)`
`void`	`setDisregardedEntityGiin(String disregardedEntityGiin)`
`void`	`setDisregardedState(String disregardedState)`
`void`	`setDisregardedZip(String disregardedZip)`
`void`	`seteDeliveryConsentedAt(OffsetDateTime eDeliveryConsentedAt)`
`void`	`setEmail(String email)`
`void`	`setEntityType(String entityType)`
`void`	`setExceptedInterAffiliateFfiCertification(Boolean exceptedInterAffiliateFfiCertification)`
`void`	`setExceptedNonfinancialEntityInLiquidationOrBankruptcyCertification(Boolean exceptedNonfinancialEntityInLiquidationOrBankruptcyCertification)`
`void`	`setExceptedNonfinancialGroupEntityCertification(Boolean exceptedNonfinancialGroupEntityCertification)`
`void`	`setExceptedNonfinancialStartUpCertification(Boolean exceptedNonfinancialStartUpCertification)`
`void`	`setExceptedTerritoryNffeCertification(Boolean exceptedTerritoryNffeCertification)`
`void`	`setExemptBeneficialOwnerOwnedInvestmentEntityCertification(Boolean exemptBeneficialOwnerOwnedInvestmentEntityCertification)`
`void`	`setExemptBeneficialOwnerSponsoredRetirementFundCertification(Boolean exemptBeneficialOwnerSponsoredRetirementFundCertification)`
`void`	`setFatcaStatus(String fatcaStatus)`
`void`	`setFfiSponsoringEntity(String ffiSponsoringEntity)`
`void`	`setForeignTin(String foreignTin)`
`void`	`setForeignTinNotRequired(Boolean foreignTinNotRequired)`
`void`	`setGiin(String giin)`
`void`	`setIgaCountry(String igaCountry)`
`void`	`setIgaFfiTrusteeIsForeign(Boolean igaFfiTrusteeIsForeign)`
`void`	`setIgaFfiTrusteeOrSponsor(String igaFfiTrusteeOrSponsor)`
`void`	`setIgaLegalStatusTreatment(String igaLegalStatusTreatment)`
`void`	`setIgaModel(String igaModel)`
`void`	`setIncomeType(String incomeType)`
`void`	`setIntergovernmentalOrganizationCertification(Boolean intergovernmentalOrganizationCertification)`
`void`	`setInternationOrganizationCertification(Boolean internationOrganizationCertification)`
`void`	`setInvestmentEntityCertification(Boolean investmentEntityCertification)`
`void`	`setInvestmentEntityForRetirementFundsCertification(Boolean investmentEntityForRetirementFundsCertification)`
`void`	`setInvestmentEntityNoFinancialAccountsCertification(Boolean investmentEntityNoFinancialAccountsCertification)`
`void`	`setMailingAddress(String mailingAddress)`
`void`	`setMailingCity(String mailingCity)`
`void`	`setMailingCountry(String mailingCountry)`
`void`	`setMailingState(String mailingState)`
`void`	`setMailingZip(String mailingZip)`
`void`	`setMakingTreatyClaim(Boolean makingTreatyClaim)`
`void`	`setName(String name)`
`void`	`setNarrowParticipationRetirementFundCertification(Boolean narrowParticipationRetirementFundCertification)`
`void`	`setNffeAffiliateOfPubliclyTradedEntityCertification(Boolean nffeAffiliateOfPubliclyTradedEntityCertification)`
`void`	`setNffeAffiliateOfPubliclyTradedEntitySecuritiesMarket(String nffeAffiliateOfPubliclyTradedEntitySecuritiesMarket)`
`void`	`setNonCommercialFinancialActivityCertification(Boolean nonCommercialFinancialActivityCertification)`
`void`	`setNonfinancialEntityFilingDate(LocalDate nonfinancialEntityFilingDate)`
`void`	`setNonprofitOrganizationCertification(Boolean nonprofitOrganizationCertification)`
`void`	`setNonreportingIgaFfiCertification(Boolean nonreportingIgaFfiCertification)`
`void`	`setOwnerDocumentedFfiAuditorLetterCertification(Boolean ownerDocumentedFfiAuditorLetterCertification)`
`void`	`setOwnerDocumentedFfiCertification(Boolean ownerDocumentedFfiCertification)`
`void`	`setOwnerDocumentedFfiReportingStatementCertification(Boolean ownerDocumentedFfiReportingStatementCertification)`
`void`	`setOwnerDocumentedFfiTrustBeneficiariesCertification(Boolean ownerDocumentedFfiTrustBeneficiariesCertification)`
`void`	`setPassiveNffeCertification(Boolean passiveNffeCertification)`
`void`	`setPassiveNffeNoSubstantialUsOwnersCertification(Boolean passiveNffeNoSubstantialUsOwnersCertification)`
`void`	`setPassiveNffeSubstantialUsOwnersProvidedCertification(Boolean passiveNffeSubstantialUsOwnersProvidedCertification)`
`void`	`setPubliclyTradedEntity(String publiclyTradedEntity)`
`void`	`setPubliclyTradedNffeCertification(Boolean publiclyTradedNffeCertification)`
`void`	`setPubliclyTradedNffeSecuritiesMarket(String publiclyTradedNffeSecuritiesMarket)`
`void`	`setQualifiedResidentStatusCertification(Boolean qualifiedResidentStatusCertification)`
`void`	`setQualifiedRetirementFundCertification(Boolean qualifiedRetirementFundCertification)`
`void`	`setReferenceId(String referenceId)`
`void`	`setReferenceNumber(String referenceNumber)`
`void`	`setResidenceAddress(String residenceAddress)`
`void`	`setResidenceCity(String residenceCity)`
`void`	`setResidenceCountry(String residenceCountry)`
`void`	`setResidenceIsMailing(Boolean residenceIsMailing)`
`void`	`setResidenceState(String residenceState)`
`void`	`setResidenceZip(String residenceZip)`
`void`	`setRestrictedDistributorAgreementCertification(Boolean restrictedDistributorAgreementCertification)`
`void`	`setRestrictedDistributorCertification(Boolean restrictedDistributorCertification)`
`void`	`setRestrictedDistributorPreexistingSalesComplianceCertification(Boolean restrictedDistributorPreexistingSalesComplianceCertification)`
`void`	`setSection401AEquivalentPensionPlanCertification(Boolean section401AEquivalentPensionPlanCertification)`
`void`	`setSection501COrganizationCertification(Boolean section501COrganizationCertification)`
`void`	`setSignature(String signature)`
`void`	`setSignerName(String signerName)`
`void`	`setSponsoredCloselyHeldEntitySponsoringEntity(String sponsoredCloselyHeldEntitySponsoringEntity)`
`void`	`setSponsoredCloselyHeldInvestmentVehicleCertification(Boolean sponsoredCloselyHeldInvestmentVehicleCertification)`
`void`	`setSponsoredDirectReportingNffeCertification(Boolean sponsoredDirectReportingNffeCertification)`
`void`	`setStartupFormationOrResolutionDate(LocalDate startupFormationOrResolutionDate)`
`void`	`setSubstantialUsOwners(List<SubstantialUsOwnerRequest> substantialUsOwners)`
`void`	`setTerritoryFinancialInstitutionCertification(Boolean territoryFinancialInstitutionCertification)`
`void`	`setTin(String tin)`
`void`	`setTreatyArticle(String treatyArticle)`
`void`	`setTreatyCountry(String treatyCountry)`
`void`	`setTreatyCountryCertification(Boolean treatyCountryCertification)`
`void`	`setTreatyQualifiedPensionFundCertification(Boolean treatyQualifiedPensionFundCertification)`
`void`	`setTreatyReasons(String treatyReasons)`
`void`	`setWithholdingRate(String withholdingRate)`
`W8BenEFormRequest`	`signature(String signature)`
`W8BenEFormRequest`	`signerName(String signerName)`
`W8BenEFormRequest`	`sponsoredCloselyHeldEntitySponsoringEntity(String sponsoredCloselyHeldEntitySponsoringEntity)`
`W8BenEFormRequest`	`sponsoredCloselyHeldInvestmentVehicleCertification(Boolean sponsoredCloselyHeldInvestmentVehicleCertification)`
`W8BenEFormRequest`	`sponsoredDirectReportingNffeCertification(Boolean sponsoredDirectReportingNffeCertification)`
`W8BenEFormRequest`	`startupFormationOrResolutionDate(LocalDate startupFormationOrResolutionDate)`
`W8BenEFormRequest`	`substantialUsOwners(List<SubstantialUsOwnerRequest> substantialUsOwners)`
`W8BenEFormRequest`	`territoryFinancialInstitutionCertification(Boolean territoryFinancialInstitutionCertification)`
`W8BenEFormRequest`	`tin(String tin)`
`String`	`toJson()`	Convert an instance of W8BenEFormRequest to an JSON string
`String`	`toString()`
`W8BenEFormRequest`	`treatyArticle(String treatyArticle)`
`W8BenEFormRequest`	`treatyCountry(String treatyCountry)`
`W8BenEFormRequest`	`treatyCountryCertification(Boolean treatyCountryCertification)`
`W8BenEFormRequest`	`treatyQualifiedPensionFundCertification(Boolean treatyQualifiedPensionFundCertification)`
`W8BenEFormRequest`	`treatyReasons(String treatyReasons)`
`static void`	`validateJsonElement(com.google.gson.JsonElement jsonElement)`	Validates the JSON Element and throws an exception if issues found
`W8BenEFormRequest`	`withholdingRate(String withholdingRate)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_TYPE

public static final String SERIALIZED_NAME_TYPE

See Also:: Constant Field Values

SERIALIZED_NAME_NAME

public static final String SERIALIZED_NAME_NAME

See Also:: Constant Field Values

SERIALIZED_NAME_CITIZENSHIP_COUNTRY

public static final String SERIALIZED_NAME_CITIZENSHIP_COUNTRY

See Also:: Constant Field Values

SERIALIZED_NAME_DISREGARDED_ENTITY

public static final String SERIALIZED_NAME_DISREGARDED_ENTITY

See Also:: Constant Field Values

SERIALIZED_NAME_ENTITY_TYPE

public static final String SERIALIZED_NAME_ENTITY_TYPE

See Also:: Constant Field Values

SERIALIZED_NAME_MAKING_TREATY_CLAIM

public static final String SERIALIZED_NAME_MAKING_TREATY_CLAIM

See Also:: Constant Field Values

SERIALIZED_NAME_FATCA_STATUS

public static final String SERIALIZED_NAME_FATCA_STATUS

See Also:: Constant Field Values

SERIALIZED_NAME_RESIDENCE_ADDRESS

public static final String SERIALIZED_NAME_RESIDENCE_ADDRESS

See Also:: Constant Field Values

SERIALIZED_NAME_RESIDENCE_CITY

public static final String SERIALIZED_NAME_RESIDENCE_CITY

See Also:: Constant Field Values

SERIALIZED_NAME_RESIDENCE_STATE

public static final String SERIALIZED_NAME_RESIDENCE_STATE

See Also:: Constant Field Values

SERIALIZED_NAME_RESIDENCE_ZIP

public static final String SERIALIZED_NAME_RESIDENCE_ZIP

See Also:: Constant Field Values

SERIALIZED_NAME_RESIDENCE_COUNTRY

public static final String SERIALIZED_NAME_RESIDENCE_COUNTRY

See Also:: Constant Field Values

SERIALIZED_NAME_RESIDENCE_IS_MAILING

public static final String SERIALIZED_NAME_RESIDENCE_IS_MAILING

See Also:: Constant Field Values

SERIALIZED_NAME_MAILING_ADDRESS

public static final String SERIALIZED_NAME_MAILING_ADDRESS

See Also:: Constant Field Values

SERIALIZED_NAME_MAILING_CITY

public static final String SERIALIZED_NAME_MAILING_CITY

See Also:: Constant Field Values

SERIALIZED_NAME_MAILING_STATE

public static final String SERIALIZED_NAME_MAILING_STATE

See Also:: Constant Field Values

SERIALIZED_NAME_MAILING_ZIP

public static final String SERIALIZED_NAME_MAILING_ZIP

See Also:: Constant Field Values

SERIALIZED_NAME_MAILING_COUNTRY

public static final String SERIALIZED_NAME_MAILING_COUNTRY

See Also:: Constant Field Values

SERIALIZED_NAME_TIN

public static final String SERIALIZED_NAME_TIN

See Also:: Constant Field Values

SERIALIZED_NAME_GIIN

public static final String SERIALIZED_NAME_GIIN

See Also:: Constant Field Values

SERIALIZED_NAME_FOREIGN_TIN_NOT_REQUIRED

public static final String SERIALIZED_NAME_FOREIGN_TIN_NOT_REQUIRED

See Also:: Constant Field Values

SERIALIZED_NAME_FOREIGN_TIN

public static final String SERIALIZED_NAME_FOREIGN_TIN

See Also:: Constant Field Values

SERIALIZED_NAME_REFERENCE_NUMBER

public static final String SERIALIZED_NAME_REFERENCE_NUMBER

See Also:: Constant Field Values

SERIALIZED_NAME_DISREGARDED_ENTITY_FATCA_STATUS

public static final String SERIALIZED_NAME_DISREGARDED_ENTITY_FATCA_STATUS

See Also:: Constant Field Values

SERIALIZED_NAME_DISREGARDED_ADDRESS

public static final String SERIALIZED_NAME_DISREGARDED_ADDRESS

See Also:: Constant Field Values

SERIALIZED_NAME_DISREGARDED_CITY

public static final String SERIALIZED_NAME_DISREGARDED_CITY

See Also:: Constant Field Values

SERIALIZED_NAME_DISREGARDED_STATE

public static final String SERIALIZED_NAME_DISREGARDED_STATE

See Also:: Constant Field Values

SERIALIZED_NAME_DISREGARDED_ZIP

public static final String SERIALIZED_NAME_DISREGARDED_ZIP

See Also:: Constant Field Values

SERIALIZED_NAME_DISREGARDED_COUNTRY

public static final String SERIALIZED_NAME_DISREGARDED_COUNTRY

See Also:: Constant Field Values

SERIALIZED_NAME_DISREGARDED_ENTITY_GIIN

public static final String SERIALIZED_NAME_DISREGARDED_ENTITY_GIIN

See Also:: Constant Field Values

SERIALIZED_NAME_TREATY_COUNTRY_CERTIFICATION

public static final String SERIALIZED_NAME_TREATY_COUNTRY_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_TREATY_COUNTRY

public static final String SERIALIZED_NAME_TREATY_COUNTRY

See Also:: Constant Field Values

SERIALIZED_NAME_BENEFIT_LIMITATION_CERTIFICATION

public static final String SERIALIZED_NAME_BENEFIT_LIMITATION_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_BENEFIT_LIMITATION

public static final String SERIALIZED_NAME_BENEFIT_LIMITATION

See Also:: Constant Field Values

SERIALIZED_NAME_QUALIFIED_RESIDENT_STATUS_CERTIFICATION

public static final String SERIALIZED_NAME_QUALIFIED_RESIDENT_STATUS_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_TREATY_ARTICLE

public static final String SERIALIZED_NAME_TREATY_ARTICLE

See Also:: Constant Field Values

SERIALIZED_NAME_WITHHOLDING_RATE

public static final String SERIALIZED_NAME_WITHHOLDING_RATE

See Also:: Constant Field Values

SERIALIZED_NAME_INCOME_TYPE

public static final String SERIALIZED_NAME_INCOME_TYPE

See Also:: Constant Field Values

SERIALIZED_NAME_TREATY_REASONS

public static final String SERIALIZED_NAME_TREATY_REASONS

See Also:: Constant Field Values

SERIALIZED_NAME_FFI_SPONSORING_ENTITY

public static final String SERIALIZED_NAME_FFI_SPONSORING_ENTITY

See Also:: Constant Field Values

SERIALIZED_NAME_INVESTMENT_ENTITY_CERTIFICATION

public static final String SERIALIZED_NAME_INVESTMENT_ENTITY_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_CONTROLLED_FOREIGN_CORPORATION_CERTIFICATION

public static final String SERIALIZED_NAME_CONTROLLED_FOREIGN_CORPORATION_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_COMPLIANT_NONREGISTERING_LOCAL_BANK_CERTIFICATION

public static final String SERIALIZED_NAME_COMPLIANT_NONREGISTERING_LOCAL_BANK_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_COMPLIANT_FFI_LOW_VALUE_ACCOUNTS_CERTIFICATION

public static final String SERIALIZED_NAME_COMPLIANT_FFI_LOW_VALUE_ACCOUNTS_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_SPONSORED_CLOSELY_HELD_ENTITY_SPONSORING_ENTITY

public static final String SERIALIZED_NAME_SPONSORED_CLOSELY_HELD_ENTITY_SPONSORING_ENTITY

See Also:: Constant Field Values

SERIALIZED_NAME_SPONSORED_CLOSELY_HELD_INVESTMENT_VEHICLE_CERTIFICATION

public static final String SERIALIZED_NAME_SPONSORED_CLOSELY_HELD_INVESTMENT_VEHICLE_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_COMPLIANT_LIMITED_LIFE_DEBT_ENTITY_CERTIFICATION

public static final String SERIALIZED_NAME_COMPLIANT_LIMITED_LIFE_DEBT_ENTITY_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_INVESTMENT_ENTITY_NO_FINANCIAL_ACCOUNTS_CERTIFICATION

public static final String SERIALIZED_NAME_INVESTMENT_ENTITY_NO_FINANCIAL_ACCOUNTS_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_OWNER_DOCUMENTED_FFI_CERTIFICATION

public static final String SERIALIZED_NAME_OWNER_DOCUMENTED_FFI_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_OWNER_DOCUMENTED_FFI_REPORTING_STATEMENT_CERTIFICATION

public static final String SERIALIZED_NAME_OWNER_DOCUMENTED_FFI_REPORTING_STATEMENT_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_OWNER_DOCUMENTED_FFI_AUDITOR_LETTER_CERTIFICATION

public static final String SERIALIZED_NAME_OWNER_DOCUMENTED_FFI_AUDITOR_LETTER_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_OWNER_DOCUMENTED_FFI_TRUST_BENEFICIARIES_CERTIFICATION

public static final String SERIALIZED_NAME_OWNER_DOCUMENTED_FFI_TRUST_BENEFICIARIES_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_RESTRICTED_DISTRIBUTOR_CERTIFICATION

public static final String SERIALIZED_NAME_RESTRICTED_DISTRIBUTOR_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_RESTRICTED_DISTRIBUTOR_AGREEMENT_CERTIFICATION

public static final String SERIALIZED_NAME_RESTRICTED_DISTRIBUTOR_AGREEMENT_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_RESTRICTED_DISTRIBUTOR_PREEXISTING_SALES_COMPLIANCE_CERTIFICATION

public static final String SERIALIZED_NAME_RESTRICTED_DISTRIBUTOR_PREEXISTING_SALES_COMPLIANCE_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_NONREPORTING_IGA_FFI_CERTIFICATION

public static final String SERIALIZED_NAME_NONREPORTING_IGA_FFI_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_IGA_COUNTRY

public static final String SERIALIZED_NAME_IGA_COUNTRY

See Also:: Constant Field Values

SERIALIZED_NAME_IGA_MODEL

public static final String SERIALIZED_NAME_IGA_MODEL

See Also:: Constant Field Values

SERIALIZED_NAME_IGA_LEGAL_STATUS_TREATMENT

public static final String SERIALIZED_NAME_IGA_LEGAL_STATUS_TREATMENT

See Also:: Constant Field Values

SERIALIZED_NAME_IGA_FFI_TRUSTEE_OR_SPONSOR

public static final String SERIALIZED_NAME_IGA_FFI_TRUSTEE_OR_SPONSOR

See Also:: Constant Field Values

SERIALIZED_NAME_IGA_FFI_TRUSTEE_IS_FOREIGN

public static final String SERIALIZED_NAME_IGA_FFI_TRUSTEE_IS_FOREIGN

See Also:: Constant Field Values

SERIALIZED_NAME_NON_COMMERCIAL_FINANCIAL_ACTIVITY_CERTIFICATION

public static final String SERIALIZED_NAME_NON_COMMERCIAL_FINANCIAL_ACTIVITY_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_INTERNATION_ORGANIZATION_CERTIFICATION

public static final String SERIALIZED_NAME_INTERNATION_ORGANIZATION_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_INTERGOVERNMENTAL_ORGANIZATION_CERTIFICATION

public static final String SERIALIZED_NAME_INTERGOVERNMENTAL_ORGANIZATION_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_TREATY_QUALIFIED_PENSION_FUND_CERTIFICATION

public static final String SERIALIZED_NAME_TREATY_QUALIFIED_PENSION_FUND_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_QUALIFIED_RETIREMENT_FUND_CERTIFICATION

public static final String SERIALIZED_NAME_QUALIFIED_RETIREMENT_FUND_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_NARROW_PARTICIPATION_RETIREMENT_FUND_CERTIFICATION

public static final String SERIALIZED_NAME_NARROW_PARTICIPATION_RETIREMENT_FUND_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_SECTION401_A_EQUIVALENT_PENSION_PLAN_CERTIFICATION

public static final String SERIALIZED_NAME_SECTION401_A_EQUIVALENT_PENSION_PLAN_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_INVESTMENT_ENTITY_FOR_RETIREMENT_FUNDS_CERTIFICATION

public static final String SERIALIZED_NAME_INVESTMENT_ENTITY_FOR_RETIREMENT_FUNDS_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_EXEMPT_BENEFICIAL_OWNER_SPONSORED_RETIREMENT_FUND_CERTIFICATION

public static final String SERIALIZED_NAME_EXEMPT_BENEFICIAL_OWNER_SPONSORED_RETIREMENT_FUND_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_EXEMPT_BENEFICIAL_OWNER_OWNED_INVESTMENT_ENTITY_CERTIFICATION

public static final String SERIALIZED_NAME_EXEMPT_BENEFICIAL_OWNER_OWNED_INVESTMENT_ENTITY_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_TERRITORY_FINANCIAL_INSTITUTION_CERTIFICATION

public static final String SERIALIZED_NAME_TERRITORY_FINANCIAL_INSTITUTION_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_EXCEPTED_NONFINANCIAL_GROUP_ENTITY_CERTIFICATION

public static final String SERIALIZED_NAME_EXCEPTED_NONFINANCIAL_GROUP_ENTITY_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_EXCEPTED_NONFINANCIAL_START_UP_CERTIFICATION

public static final String SERIALIZED_NAME_EXCEPTED_NONFINANCIAL_START_UP_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_STARTUP_FORMATION_OR_RESOLUTION_DATE

public static final String SERIALIZED_NAME_STARTUP_FORMATION_OR_RESOLUTION_DATE

See Also:: Constant Field Values

SERIALIZED_NAME_EXCEPTED_NONFINANCIAL_ENTITY_IN_LIQUIDATION_OR_BANKRUPTCY_CERTIFICATION

public static final String SERIALIZED_NAME_EXCEPTED_NONFINANCIAL_ENTITY_IN_LIQUIDATION_OR_BANKRUPTCY_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_NONFINANCIAL_ENTITY_FILING_DATE

public static final String SERIALIZED_NAME_NONFINANCIAL_ENTITY_FILING_DATE

See Also:: Constant Field Values

SERIALIZED_NAME_SECTION501_C_ORGANIZATION_CERTIFICATION

public static final String SERIALIZED_NAME_SECTION501_C_ORGANIZATION_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_DETERMINATION_LETTER_DATE

public static final String SERIALIZED_NAME_DETERMINATION_LETTER_DATE

See Also:: Constant Field Values

SERIALIZED_NAME_NONPROFIT_ORGANIZATION_CERTIFICATION

public static final String SERIALIZED_NAME_NONPROFIT_ORGANIZATION_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_PUBLICLY_TRADED_NFFE_CERTIFICATION

public static final String SERIALIZED_NAME_PUBLICLY_TRADED_NFFE_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_PUBLICLY_TRADED_NFFE_SECURITIES_MARKET

public static final String SERIALIZED_NAME_PUBLICLY_TRADED_NFFE_SECURITIES_MARKET

See Also:: Constant Field Values

SERIALIZED_NAME_NFFE_AFFILIATE_OF_PUBLICLY_TRADED_ENTITY_CERTIFICATION

public static final String SERIALIZED_NAME_NFFE_AFFILIATE_OF_PUBLICLY_TRADED_ENTITY_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_PUBLICLY_TRADED_ENTITY

public static final String SERIALIZED_NAME_PUBLICLY_TRADED_ENTITY

See Also:: Constant Field Values

SERIALIZED_NAME_NFFE_AFFILIATE_OF_PUBLICLY_TRADED_ENTITY_SECURITIES_MARKET

public static final String SERIALIZED_NAME_NFFE_AFFILIATE_OF_PUBLICLY_TRADED_ENTITY_SECURITIES_MARKET

See Also:: Constant Field Values

SERIALIZED_NAME_EXCEPTED_TERRITORY_NFFE_CERTIFICATION

public static final String SERIALIZED_NAME_EXCEPTED_TERRITORY_NFFE_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_ACTIVE_NFFE_CERTIFICATION

public static final String SERIALIZED_NAME_ACTIVE_NFFE_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_PASSIVE_NFFE_CERTIFICATION

public static final String SERIALIZED_NAME_PASSIVE_NFFE_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_PASSIVE_NFFE_NO_SUBSTANTIAL_US_OWNERS_CERTIFICATION

public static final String SERIALIZED_NAME_PASSIVE_NFFE_NO_SUBSTANTIAL_US_OWNERS_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_PASSIVE_NFFE_SUBSTANTIAL_US_OWNERS_PROVIDED_CERTIFICATION

public static final String SERIALIZED_NAME_PASSIVE_NFFE_SUBSTANTIAL_US_OWNERS_PROVIDED_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_EXCEPTED_INTER_AFFILIATE_FFI_CERTIFICATION

public static final String SERIALIZED_NAME_EXCEPTED_INTER_AFFILIATE_FFI_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_SPONSORED_DIRECT_REPORTING_NFFE_CERTIFICATION

public static final String SERIALIZED_NAME_SPONSORED_DIRECT_REPORTING_NFFE_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_DIRECT_REPORTING_NFFE_SPONSORING_ENTITY

public static final String SERIALIZED_NAME_DIRECT_REPORTING_NFFE_SPONSORING_ENTITY

See Also:: Constant Field Values

SERIALIZED_NAME_SUBSTANTIAL_US_OWNERS

public static final String SERIALIZED_NAME_SUBSTANTIAL_US_OWNERS

See Also:: Constant Field Values

SERIALIZED_NAME_SIGNER_NAME

public static final String SERIALIZED_NAME_SIGNER_NAME

See Also:: Constant Field Values

SERIALIZED_NAME_CAPACITY_TO_SIGN_CERTIFICATION

public static final String SERIALIZED_NAME_CAPACITY_TO_SIGN_CERTIFICATION

See Also:: Constant Field Values

SERIALIZED_NAME_E_DELIVERY_CONSENTED_AT

public static final String SERIALIZED_NAME_E_DELIVERY_CONSENTED_AT

See Also:: Constant Field Values

SERIALIZED_NAME_SIGNATURE

public static final String SERIALIZED_NAME_SIGNATURE

See Also:: Constant Field Values

SERIALIZED_NAME_COMPANY_ID

public static final String SERIALIZED_NAME_COMPANY_ID

See Also:: Constant Field Values

SERIALIZED_NAME_REFERENCE_ID

public static final String SERIALIZED_NAME_REFERENCE_ID

See Also:: Constant Field Values

SERIALIZED_NAME_EMAIL

public static final String SERIALIZED_NAME_EMAIL

See Also:: Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

W8BenEFormRequest
```
public W8BenEFormRequest()
```

W8BenEFormRequest

public W8BenEFormRequest(W8BenEFormRequest.TypeEnum type)

Method Detail

getType
```
@Nullable
public W8BenEFormRequest.TypeEnum getType()
```
The form type (always \"w8bene\" for this model).

Returns:

type

name

public W8BenEFormRequest name(String name)

getName
```
@Nullable
public String getName()
```
The name of the individual or entity associated with the form.

Returns:

name

setName
```
public void setName(String name)
```

citizenshipCountry

public W8BenEFormRequest citizenshipCountry(String citizenshipCountry)

getCitizenshipCountry
```
@Nullable
public String getCitizenshipCountry()
```
The country of citizenship.

Returns:

citizenshipCountry

setCitizenshipCountry

public void setCitizenshipCountry(String citizenshipCountry)

disregardedEntity

public W8BenEFormRequest disregardedEntity(String disregardedEntity)

getDisregardedEntity
```
@Nullable
public String getDisregardedEntity()
```
The name of the disregarded entity receiving the payment (if applicable).

Returns:

disregardedEntity

setDisregardedEntity

public void setDisregardedEntity(String disregardedEntity)

entityType

public W8BenEFormRequest entityType(String entityType)

getEntityType
```
@Nullable
public String getEntityType()
```
The entity type.

Returns:

entityType

setEntityType

public void setEntityType(String entityType)

makingTreatyClaim

public W8BenEFormRequest makingTreatyClaim(Boolean makingTreatyClaim)

getMakingTreatyClaim
```
@Nullable
public Boolean getMakingTreatyClaim()
```
Indicates whether the entity is making a treaty claim.

Returns:

makingTreatyClaim

setMakingTreatyClaim

public void setMakingTreatyClaim(Boolean makingTreatyClaim)

fatcaStatus

public W8BenEFormRequest fatcaStatus(String fatcaStatus)

getFatcaStatus
```
@Nullable
public String getFatcaStatus()
```
The FATCA status.

Returns:

fatcaStatus

setFatcaStatus

public void setFatcaStatus(String fatcaStatus)

residenceAddress

public W8BenEFormRequest residenceAddress(String residenceAddress)

getResidenceAddress
```
@Nullable
public String getResidenceAddress()
```
The residential address of the individual or entity.

Returns:

residenceAddress

setResidenceAddress

public void setResidenceAddress(String residenceAddress)

residenceCity

public W8BenEFormRequest residenceCity(String residenceCity)

getResidenceCity
```
@Nullable
public String getResidenceCity()
```
The city of residence.

Returns:

residenceCity

setResidenceCity

public void setResidenceCity(String residenceCity)

residenceState

public W8BenEFormRequest residenceState(String residenceState)

getResidenceState
```
@Nullable
public String getResidenceState()
```
The state of residence.

Returns:

residenceState

setResidenceState

public void setResidenceState(String residenceState)

residenceZip

public W8BenEFormRequest residenceZip(String residenceZip)

getResidenceZip
```
@Nullable
public String getResidenceZip()
```
The ZIP code of the residence.

Returns:

residenceZip

setResidenceZip

public void setResidenceZip(String residenceZip)

residenceCountry

public W8BenEFormRequest residenceCountry(String residenceCountry)

getResidenceCountry
```
@Nullable
public String getResidenceCountry()
```
The country of residence.

Returns:

residenceCountry

setResidenceCountry

public void setResidenceCountry(String residenceCountry)

residenceIsMailing

public W8BenEFormRequest residenceIsMailing(Boolean residenceIsMailing)

getResidenceIsMailing
```
@Nullable
public Boolean getResidenceIsMailing()
```
Indicates whether the residence address is also the mailing address.

Returns:

residenceIsMailing

setResidenceIsMailing

public void setResidenceIsMailing(Boolean residenceIsMailing)

mailingAddress

public W8BenEFormRequest mailingAddress(String mailingAddress)

getMailingAddress
```
@Nullable
public String getMailingAddress()
```
The mailing address.

Returns:

mailingAddress

setMailingAddress

public void setMailingAddress(String mailingAddress)

mailingCity

public W8BenEFormRequest mailingCity(String mailingCity)

getMailingCity
```
@Nullable
public String getMailingCity()
```
The city of the mailing address.

Returns:

mailingCity

setMailingCity

public void setMailingCity(String mailingCity)

mailingState

public W8BenEFormRequest mailingState(String mailingState)

getMailingState
```
@Nullable
public String getMailingState()
```
The state of the mailing address.

Returns:

mailingState

setMailingState

public void setMailingState(String mailingState)

mailingZip

public W8BenEFormRequest mailingZip(String mailingZip)

getMailingZip
```
@Nullable
public String getMailingZip()
```
The ZIP code of the mailing address.

Returns:

mailingZip

setMailingZip

public void setMailingZip(String mailingZip)

mailingCountry

public W8BenEFormRequest mailingCountry(String mailingCountry)

getMailingCountry
```
@Nullable
public String getMailingCountry()
```
The country of the mailing address.

Returns:

mailingCountry

setMailingCountry

public void setMailingCountry(String mailingCountry)

tin

public W8BenEFormRequest tin(String tin)

getTin
```
@Nullable
public String getTin()
```
The taxpayer identification number (TIN).

Returns:

tin

setTin
```
public void setTin(String tin)
```

giin

public W8BenEFormRequest giin(String giin)

getGiin
```
@Nullable
public String getGiin()
```
The global intermediary identification number (GIIN).

Returns:

giin

setGiin
```
public void setGiin(String giin)
```

foreignTinNotRequired

public W8BenEFormRequest foreignTinNotRequired(Boolean foreignTinNotRequired)

getForeignTinNotRequired
```
@Nullable
public Boolean getForeignTinNotRequired()
```
Indicates whether a foreign TIN is not required.

Returns:

foreignTinNotRequired

setForeignTinNotRequired

public void setForeignTinNotRequired(Boolean foreignTinNotRequired)

foreignTin

public W8BenEFormRequest foreignTin(String foreignTin)

getForeignTin
```
@Nullable
public String getForeignTin()
```
The foreign taxpayer identification number (TIN).

Returns:

foreignTin

setForeignTin

public void setForeignTin(String foreignTin)

referenceNumber

public W8BenEFormRequest referenceNumber(String referenceNumber)

getReferenceNumber
```
@Nullable
public String getReferenceNumber()
```
A reference number for the form.

Returns:

referenceNumber

setReferenceNumber

public void setReferenceNumber(String referenceNumber)

disregardedEntityFatcaStatus

public W8BenEFormRequest disregardedEntityFatcaStatus(String disregardedEntityFatcaStatus)

getDisregardedEntityFatcaStatus
```
@Nullable
public String getDisregardedEntityFatcaStatus()
```
The FATCA status of disregarded entity or branch receiving payment.

Returns:

disregardedEntityFatcaStatus

setDisregardedEntityFatcaStatus

public void setDisregardedEntityFatcaStatus(String disregardedEntityFatcaStatus)

disregardedAddress

public W8BenEFormRequest disregardedAddress(String disregardedAddress)

getDisregardedAddress
```
@Nullable
public String getDisregardedAddress()
```
The address for disregarded entities.

Returns:

disregardedAddress

setDisregardedAddress

public void setDisregardedAddress(String disregardedAddress)

disregardedCity

public W8BenEFormRequest disregardedCity(String disregardedCity)

getDisregardedCity
```
@Nullable
public String getDisregardedCity()
```
The city for disregarded entities.

Returns:

disregardedCity

setDisregardedCity

public void setDisregardedCity(String disregardedCity)

disregardedState

public W8BenEFormRequest disregardedState(String disregardedState)

getDisregardedState
```
@Nullable
public String getDisregardedState()
```
The state for disregarded entities.

Returns:

disregardedState

setDisregardedState

public void setDisregardedState(String disregardedState)

disregardedZip

public W8BenEFormRequest disregardedZip(String disregardedZip)

getDisregardedZip
```
@Nullable
public String getDisregardedZip()
```
The ZIP code for disregarded entities.

Returns:

disregardedZip

setDisregardedZip

public void setDisregardedZip(String disregardedZip)

disregardedCountry

public W8BenEFormRequest disregardedCountry(String disregardedCountry)

getDisregardedCountry
```
@Nullable
public String getDisregardedCountry()
```
The country for disregarded entities.

Returns:

disregardedCountry

setDisregardedCountry

public void setDisregardedCountry(String disregardedCountry)

disregardedEntityGiin

public W8BenEFormRequest disregardedEntityGiin(String disregardedEntityGiin)

getDisregardedEntityGiin
```
@Nullable
public String getDisregardedEntityGiin()
```
The GIIN for disregarded entities.

Returns:

disregardedEntityGiin

setDisregardedEntityGiin

public void setDisregardedEntityGiin(String disregardedEntityGiin)

treatyCountryCertification

public W8BenEFormRequest treatyCountryCertification(Boolean treatyCountryCertification)

getTreatyCountryCertification
```
@Nullable
public Boolean getTreatyCountryCertification()
```
Certifies the beneficial owner's country under the U.S. tax treaty.

Returns:

treatyCountryCertification

setTreatyCountryCertification

public void setTreatyCountryCertification(Boolean treatyCountryCertification)

treatyCountry

public W8BenEFormRequest treatyCountry(String treatyCountry)

getTreatyCountry
```
@Nullable
public String getTreatyCountry()
```
The treaty country of the beneficial owner.

Returns:

treatyCountry

setTreatyCountry

public void setTreatyCountry(String treatyCountry)

benefitLimitationCertification

public W8BenEFormRequest benefitLimitationCertification(Boolean benefitLimitationCertification)

getBenefitLimitationCertification
```
@Nullable
public Boolean getBenefitLimitationCertification()
```
Certifies that the beneficial owner is eligible for treaty benefits and meets any limitation on benefits requirements.

Returns:

benefitLimitationCertification

setBenefitLimitationCertification

public void setBenefitLimitationCertification(Boolean benefitLimitationCertification)

benefitLimitation

public W8BenEFormRequest benefitLimitation(String benefitLimitation)

getBenefitLimitation
```
@Nullable
public String getBenefitLimitation()
```
The benefit limitation for tax treaty claims.

Returns:

benefitLimitation

setBenefitLimitation

public void setBenefitLimitation(String benefitLimitation)

qualifiedResidentStatusCertification

public W8BenEFormRequest qualifiedResidentStatusCertification(Boolean qualifiedResidentStatusCertification)

getQualifiedResidentStatusCertification
```
@Nullable
public Boolean getQualifiedResidentStatusCertification()
```
Certifies that the beneficial owner claims treaty benefits and meets the qualified resident status for specific U.S. source income.

Returns:

qualifiedResidentStatusCertification

setQualifiedResidentStatusCertification

public void setQualifiedResidentStatusCertification(Boolean qualifiedResidentStatusCertification)

treatyArticle

public W8BenEFormRequest treatyArticle(String treatyArticle)

getTreatyArticle
```
@Nullable
public String getTreatyArticle()
```
Indicates the specific article and paragraph of the tax treaty under which the beneficial owner is claiming benefits.

Returns:

treatyArticle

setTreatyArticle

public void setTreatyArticle(String treatyArticle)

withholdingRate

public W8BenEFormRequest withholdingRate(String withholdingRate)

getWithholdingRate
```
@Nullable
public String getWithholdingRate()
```
Specifies the reduced withholding rate claimed under the applicable tax treaty.

Returns:

withholdingRate

setWithholdingRate

public void setWithholdingRate(String withholdingRate)

incomeType

public W8BenEFormRequest incomeType(String incomeType)

getIncomeType
```
@Nullable
public String getIncomeType()
```
Specifies the type of income for which the reduced treaty withholding rate is being claimed.

Returns:

incomeType

setIncomeType

public void setIncomeType(String incomeType)

treatyReasons

public W8BenEFormRequest treatyReasons(String treatyReasons)

getTreatyReasons
```
@Nullable
public String getTreatyReasons()
```
The additional conditions in the article the beneficial owner meets to be eligible for the rate of withholding.

Returns:

treatyReasons

setTreatyReasons

public void setTreatyReasons(String treatyReasons)

ffiSponsoringEntity

public W8BenEFormRequest ffiSponsoringEntity(String ffiSponsoringEntity)

getFfiSponsoringEntity
```
@Nullable
public String getFfiSponsoringEntity()
```
The name of the entity that sponsors the foreign financial institution (FFI).

Returns:

ffiSponsoringEntity

setFfiSponsoringEntity

public void setFfiSponsoringEntity(String ffiSponsoringEntity)

investmentEntityCertification

public W8BenEFormRequest investmentEntityCertification(Boolean investmentEntityCertification)

getInvestmentEntityCertification
```
@Nullable
public Boolean getInvestmentEntityCertification()
```
Certifies that the entity is an investment entity, not a QI, WP, or WT, and has an agreement with a sponsoring entity.

Returns:

investmentEntityCertification

setInvestmentEntityCertification

public void setInvestmentEntityCertification(Boolean investmentEntityCertification)

controlledForeignCorporationCertification

public W8BenEFormRequest controlledForeignCorporationCertification(Boolean controlledForeignCorporationCertification)

getControlledForeignCorporationCertification
```
@Nullable
public Boolean getControlledForeignCorporationCertification()
```
Certifies that the entity is a controlled foreign corporation sponsored by a U.S. financial institution, not a QI, WP, or WT, and shares a common electronic account system for full transparency.

Returns:

controlledForeignCorporationCertification

setControlledForeignCorporationCertification

public void setControlledForeignCorporationCertification(Boolean controlledForeignCorporationCertification)

compliantNonregisteringLocalBankCertification

public W8BenEFormRequest compliantNonregisteringLocalBankCertification(Boolean compliantNonregisteringLocalBankCertification)

getCompliantNonregisteringLocalBankCertification
```
@Nullable
public Boolean getCompliantNonregisteringLocalBankCertification()
```
Certifies that the FFI operates solely as a limited bank or credit union within its country, meets asset thresholds, and has no foreign operations or affiliations outside its country of organization.

Returns:

compliantNonregisteringLocalBankCertification

setCompliantNonregisteringLocalBankCertification

public void setCompliantNonregisteringLocalBankCertification(Boolean compliantNonregisteringLocalBankCertification)

compliantFfiLowValueAccountsCertification

public W8BenEFormRequest compliantFfiLowValueAccountsCertification(Boolean compliantFfiLowValueAccountsCertification)

getCompliantFfiLowValueAccountsCertification
```
@Nullable
public Boolean getCompliantFfiLowValueAccountsCertification()
```
Certifies that the FFI is not primarily engaged in investment activities, maintains only low-value accounts, and has limited total assets within its group.

Returns:

compliantFfiLowValueAccountsCertification

setCompliantFfiLowValueAccountsCertification

public void setCompliantFfiLowValueAccountsCertification(Boolean compliantFfiLowValueAccountsCertification)

sponsoredCloselyHeldEntitySponsoringEntity

public W8BenEFormRequest sponsoredCloselyHeldEntitySponsoringEntity(String sponsoredCloselyHeldEntitySponsoringEntity)

getSponsoredCloselyHeldEntitySponsoringEntity
```
@Nullable
public String getSponsoredCloselyHeldEntitySponsoringEntity()
```
The name of sponsoring entity for a certified deemed-compliant, closely held investment vehicle.

Returns:

sponsoredCloselyHeldEntitySponsoringEntity

setSponsoredCloselyHeldEntitySponsoringEntity

public void setSponsoredCloselyHeldEntitySponsoringEntity(String sponsoredCloselyHeldEntitySponsoringEntity)

sponsoredCloselyHeldInvestmentVehicleCertification

public W8BenEFormRequest sponsoredCloselyHeldInvestmentVehicleCertification(Boolean sponsoredCloselyHeldInvestmentVehicleCertification)

getSponsoredCloselyHeldInvestmentVehicleCertification
```
@Nullable
public Boolean getSponsoredCloselyHeldInvestmentVehicleCertification()
```
Certifies that the entity is a sponsored investment entity with 20 or fewer individual owners, and that all compliance obligations are fulfilled by the sponsoring entity.

Returns:

sponsoredCloselyHeldInvestmentVehicleCertification

setSponsoredCloselyHeldInvestmentVehicleCertification

public void setSponsoredCloselyHeldInvestmentVehicleCertification(Boolean sponsoredCloselyHeldInvestmentVehicleCertification)

compliantLimitedLifeDebtEntityCertification

public W8BenEFormRequest compliantLimitedLifeDebtEntityCertification(Boolean compliantLimitedLifeDebtEntityCertification)

getCompliantLimitedLifeDebtEntityCertification
```
@Nullable
public Boolean getCompliantLimitedLifeDebtEntityCertification()
```
Certifies that the entity qualifies as a limited life debt investment entity based on its formation date, issuance terms, and compliance with regulatory requirements.

Returns:

compliantLimitedLifeDebtEntityCertification

setCompliantLimitedLifeDebtEntityCertification

public void setCompliantLimitedLifeDebtEntityCertification(Boolean compliantLimitedLifeDebtEntityCertification)

investmentEntityNoFinancialAccountsCertification

public W8BenEFormRequest investmentEntityNoFinancialAccountsCertification(Boolean investmentEntityNoFinancialAccountsCertification)

getInvestmentEntityNoFinancialAccountsCertification
```
@Nullable
public Boolean getInvestmentEntityNoFinancialAccountsCertification()
```
Certifies that the entity is a financial institution solely because it is an investment entity under regulations and the entity does not maintain financial accounts.

Returns:

investmentEntityNoFinancialAccountsCertification

setInvestmentEntityNoFinancialAccountsCertification

public void setInvestmentEntityNoFinancialAccountsCertification(Boolean investmentEntityNoFinancialAccountsCertification)

ownerDocumentedFfiCertification

public W8BenEFormRequest ownerDocumentedFfiCertification(Boolean ownerDocumentedFfiCertification)

getOwnerDocumentedFfiCertification
```
@Nullable
public Boolean getOwnerDocumentedFfiCertification()
```
Certifies that the FFI meets all requirements to qualify as an owner-documented FFI, including restrictions on activities, ownership, and account relationships.

Returns:

ownerDocumentedFfiCertification

setOwnerDocumentedFfiCertification

public void setOwnerDocumentedFfiCertification(Boolean ownerDocumentedFfiCertification)

ownerDocumentedFfiReportingStatementCertification

public W8BenEFormRequest ownerDocumentedFfiReportingStatementCertification(Boolean ownerDocumentedFfiReportingStatementCertification)

getOwnerDocumentedFfiReportingStatementCertification
```
@Nullable
public Boolean getOwnerDocumentedFfiReportingStatementCertification()
```
Certifies that the FFI will provide a complete owner reporting statement and required documentation for each relevant owner or debt holder.

Returns:

ownerDocumentedFfiReportingStatementCertification

setOwnerDocumentedFfiReportingStatementCertification

public void setOwnerDocumentedFfiReportingStatementCertification(Boolean ownerDocumentedFfiReportingStatementCertification)

ownerDocumentedFfiAuditorLetterCertification

public W8BenEFormRequest ownerDocumentedFfiAuditorLetterCertification(Boolean ownerDocumentedFfiAuditorLetterCertification)

getOwnerDocumentedFfiAuditorLetterCertification
```
@Nullable
public Boolean getOwnerDocumentedFfiAuditorLetterCertification()
```
Certifies that the FFI will provide an auditor’s letter and required owner reporting documentation to confirm its status as an owner-documented FFI.

Returns:

ownerDocumentedFfiAuditorLetterCertification

setOwnerDocumentedFfiAuditorLetterCertification

public void setOwnerDocumentedFfiAuditorLetterCertification(Boolean ownerDocumentedFfiAuditorLetterCertification)

ownerDocumentedFfiTrustBeneficiariesCertification

public W8BenEFormRequest ownerDocumentedFfiTrustBeneficiariesCertification(Boolean ownerDocumentedFfiTrustBeneficiariesCertification)

getOwnerDocumentedFfiTrustBeneficiariesCertification
```
@Nullable
public Boolean getOwnerDocumentedFfiTrustBeneficiariesCertification()
```
Certifies that the trust has no contingent or unidentified beneficiaries or designated classes of beneficiaries.

Returns:

ownerDocumentedFfiTrustBeneficiariesCertification

setOwnerDocumentedFfiTrustBeneficiariesCertification

public void setOwnerDocumentedFfiTrustBeneficiariesCertification(Boolean ownerDocumentedFfiTrustBeneficiariesCertification)

restrictedDistributorCertification

public W8BenEFormRequest restrictedDistributorCertification(Boolean restrictedDistributorCertification)

getRestrictedDistributorCertification
```
@Nullable
public Boolean getRestrictedDistributorCertification()
```
Certifies that the entity qualifies as a restricted distributor based on its operations, customer base, regulatory compliance, and financial and geographic limitations.

Returns:

restrictedDistributorCertification

setRestrictedDistributorCertification

public void setRestrictedDistributorCertification(Boolean restrictedDistributorCertification)

restrictedDistributorAgreementCertification

public W8BenEFormRequest restrictedDistributorAgreementCertification(Boolean restrictedDistributorAgreementCertification)

getRestrictedDistributorAgreementCertification
```
@Nullable
public Boolean getRestrictedDistributorAgreementCertification()
```
Certifies that the entity is, and has been, bound by distribution agreements prohibiting sales of fund interests to specified U.S. persons and certain non-U.S. entities.

Returns:

restrictedDistributorAgreementCertification

setRestrictedDistributorAgreementCertification

public void setRestrictedDistributorAgreementCertification(Boolean restrictedDistributorAgreementCertification)

restrictedDistributorPreexistingSalesComplianceCertification

public W8BenEFormRequest restrictedDistributorPreexistingSalesComplianceCertification(Boolean restrictedDistributorPreexistingSalesComplianceCertification)

getRestrictedDistributorPreexistingSalesComplianceCertification
```
@Nullable
public Boolean getRestrictedDistributorPreexistingSalesComplianceCertification()
```
Certifies that the entity complies with distribution restrictions for U.S.-linked investors and has addressed any preexisting sales in accordance with FATCA regulations.

Returns:

restrictedDistributorPreexistingSalesComplianceCertification

setRestrictedDistributorPreexistingSalesComplianceCertification

public void setRestrictedDistributorPreexistingSalesComplianceCertification(Boolean restrictedDistributorPreexistingSalesComplianceCertification)

nonreportingIgaFfiCertification

public W8BenEFormRequest nonreportingIgaFfiCertification(Boolean nonreportingIgaFfiCertification)

getNonreportingIgaFfiCertification
```
@Nullable
public Boolean getNonreportingIgaFfiCertification()
```
Certifies that the entity meets the requirements to be considered a nonreporting financial institution to an applicable IGA.

Returns:

nonreportingIgaFfiCertification

setNonreportingIgaFfiCertification

public void setNonreportingIgaFfiCertification(Boolean nonreportingIgaFfiCertification)

igaCountry

public W8BenEFormRequest igaCountry(String igaCountry)

getIgaCountry
```
@Nullable
public String getIgaCountry()
```
The country for the applicable IGA with the United States.

Returns:

igaCountry

setIgaCountry

public void setIgaCountry(String igaCountry)

igaModel

public W8BenEFormRequest igaModel(String igaModel)

getIgaModel
```
@Nullable
public String getIgaModel()
```
The applicable IGA model.

Returns:

igaModel

setIgaModel

public void setIgaModel(String igaModel)

igaLegalStatusTreatment

public W8BenEFormRequest igaLegalStatusTreatment(String igaLegalStatusTreatment)

getIgaLegalStatusTreatment
```
@Nullable
public String getIgaLegalStatusTreatment()
```
Specifies how the applicable IGA is treated under the IGA provisions or Treasury regulations.

Returns:

igaLegalStatusTreatment

setIgaLegalStatusTreatment

public void setIgaLegalStatusTreatment(String igaLegalStatusTreatment)

igaFfiTrusteeOrSponsor

public W8BenEFormRequest igaFfiTrusteeOrSponsor(String igaFfiTrusteeOrSponsor)

getIgaFfiTrusteeOrSponsor
```
@Nullable
public String getIgaFfiTrusteeOrSponsor()
```
The trustee or sponsor name for the nonreporting IGA FFI.

Returns:

igaFfiTrusteeOrSponsor

setIgaFfiTrusteeOrSponsor

public void setIgaFfiTrusteeOrSponsor(String igaFfiTrusteeOrSponsor)

igaFfiTrusteeIsForeign

public W8BenEFormRequest igaFfiTrusteeIsForeign(Boolean igaFfiTrusteeIsForeign)

getIgaFfiTrusteeIsForeign
```
@Nullable
public Boolean getIgaFfiTrusteeIsForeign()
```
Indicates whether the trustee for the nonreporting IGA FFI is foreign.

Returns:

igaFfiTrusteeIsForeign

setIgaFfiTrusteeIsForeign

public void setIgaFfiTrusteeIsForeign(Boolean igaFfiTrusteeIsForeign)

nonCommercialFinancialActivityCertification

public W8BenEFormRequest nonCommercialFinancialActivityCertification(Boolean nonCommercialFinancialActivityCertification)

getNonCommercialFinancialActivityCertification
```
@Nullable
public Boolean getNonCommercialFinancialActivityCertification()
```
Certifies that the entity is the beneficial owner and is not engaged in commercial financial activities related to the specified payments, accounts or obligations for which this form is submitted.

Returns:

nonCommercialFinancialActivityCertification

setNonCommercialFinancialActivityCertification

public void setNonCommercialFinancialActivityCertification(Boolean nonCommercialFinancialActivityCertification)

internationOrganizationCertification

public W8BenEFormRequest internationOrganizationCertification(Boolean internationOrganizationCertification)

getInternationOrganizationCertification
```
@Nullable
public Boolean getInternationOrganizationCertification()
```
Certifies that the entity is an international organization described in section 7701(a)(18).

Returns:

internationOrganizationCertification

setInternationOrganizationCertification

public void setInternationOrganizationCertification(Boolean internationOrganizationCertification)

intergovernmentalOrganizationCertification

public W8BenEFormRequest intergovernmentalOrganizationCertification(Boolean intergovernmentalOrganizationCertification)

getIntergovernmentalOrganizationCertification
```
@Nullable
public Boolean getIntergovernmentalOrganizationCertification()
```
Certifies that the entity is an intergovernmental or supranational organization primarily comprised of foreign governments, is the beneficial owner, and is not engaged in commercial financial activities.

Returns:

intergovernmentalOrganizationCertification

setIntergovernmentalOrganizationCertification

public void setIntergovernmentalOrganizationCertification(Boolean intergovernmentalOrganizationCertification)

treatyQualifiedPensionFundCertification

public W8BenEFormRequest treatyQualifiedPensionFundCertification(Boolean treatyQualifiedPensionFundCertification)

getTreatyQualifiedPensionFundCertification
```
@Nullable
public Boolean getTreatyQualifiedPensionFundCertification()
```
Certifies that the entity is a pension or retirement fund established in a treaty country and is entitled to treaty benefits on U.S. source income.

Returns:

treatyQualifiedPensionFundCertification

setTreatyQualifiedPensionFundCertification

public void setTreatyQualifiedPensionFundCertification(Boolean treatyQualifiedPensionFundCertification)

qualifiedRetirementFundCertification

public W8BenEFormRequest qualifiedRetirementFundCertification(Boolean qualifiedRetirementFundCertification)

getQualifiedRetirementFundCertification
```
@Nullable
public Boolean getQualifiedRetirementFundCertification()
```
Certifies that the entity is a government-regulated retirement fund meeting specific requirements for contributions, tax exemption, beneficiary limits, and distribution restrictions.

Returns:

qualifiedRetirementFundCertification

setQualifiedRetirementFundCertification

public void setQualifiedRetirementFundCertification(Boolean qualifiedRetirementFundCertification)

narrowParticipationRetirementFundCertification

public W8BenEFormRequest narrowParticipationRetirementFundCertification(Boolean narrowParticipationRetirementFundCertification)

getNarrowParticipationRetirementFundCertification
```
@Nullable
public Boolean getNarrowParticipationRetirementFundCertification()
```
Certifies that the entity is a government-regulated retirement fund with fewer than 50 participants, limited foreign ownership, and employer sponsorship that is not from investment entities or passive NFFEs.

Returns:

narrowParticipationRetirementFundCertification

setNarrowParticipationRetirementFundCertification

public void setNarrowParticipationRetirementFundCertification(Boolean narrowParticipationRetirementFundCertification)

section401AEquivalentPensionPlanCertification

public W8BenEFormRequest section401AEquivalentPensionPlanCertification(Boolean section401AEquivalentPensionPlanCertification)

getSection401AEquivalentPensionPlanCertification
```
@Nullable
public Boolean getSection401AEquivalentPensionPlanCertification()
```
Certifies that the entity is formed under a pension plan meeting section 401(a) requirements, except for being U.S.-trust funded.

Returns:

section401AEquivalentPensionPlanCertification

setSection401AEquivalentPensionPlanCertification

public void setSection401AEquivalentPensionPlanCertification(Boolean section401AEquivalentPensionPlanCertification)

investmentEntityForRetirementFundsCertification

public W8BenEFormRequest investmentEntityForRetirementFundsCertification(Boolean investmentEntityForRetirementFundsCertification)

getInvestmentEntityForRetirementFundsCertification
```
@Nullable
public Boolean getInvestmentEntityForRetirementFundsCertification()
```
Certifies that the entity is established solely to earn income for the benefit of qualifying retirement funds or accounts under applicable FATCA regulations or IGAs.

Returns:

investmentEntityForRetirementFundsCertification

setInvestmentEntityForRetirementFundsCertification

public void setInvestmentEntityForRetirementFundsCertification(Boolean investmentEntityForRetirementFundsCertification)

exemptBeneficialOwnerSponsoredRetirementFundCertification

public W8BenEFormRequest exemptBeneficialOwnerSponsoredRetirementFundCertification(Boolean exemptBeneficialOwnerSponsoredRetirementFundCertification)

getExemptBeneficialOwnerSponsoredRetirementFundCertification
```
@Nullable
public Boolean getExemptBeneficialOwnerSponsoredRetirementFundCertification()
```
Certifies that the entity is established and sponsored by a qualifying exempt beneficial owner to provide retirement, disability, or death benefits to individuals based on services performed for the sponsor.

Returns:

exemptBeneficialOwnerSponsoredRetirementFundCertification

setExemptBeneficialOwnerSponsoredRetirementFundCertification

public void setExemptBeneficialOwnerSponsoredRetirementFundCertification(Boolean exemptBeneficialOwnerSponsoredRetirementFundCertification)

exemptBeneficialOwnerOwnedInvestmentEntityCertification

public W8BenEFormRequest exemptBeneficialOwnerOwnedInvestmentEntityCertification(Boolean exemptBeneficialOwnerOwnedInvestmentEntityCertification)

getExemptBeneficialOwnerOwnedInvestmentEntityCertification
```
@Nullable
public Boolean getExemptBeneficialOwnerOwnedInvestmentEntityCertification()
```
Certifies that the entity is an investment entity wholly owned by exempt beneficial owners and has provided complete ownership and documentation details as required under FATCA regulations.

Returns:

exemptBeneficialOwnerOwnedInvestmentEntityCertification

setExemptBeneficialOwnerOwnedInvestmentEntityCertification

public void setExemptBeneficialOwnerOwnedInvestmentEntityCertification(Boolean exemptBeneficialOwnerOwnedInvestmentEntityCertification)

territoryFinancialInstitutionCertification

public W8BenEFormRequest territoryFinancialInstitutionCertification(Boolean territoryFinancialInstitutionCertification)

getTerritoryFinancialInstitutionCertification
```
@Nullable
public Boolean getTerritoryFinancialInstitutionCertification()
```
Certifies that the entity is a financial institution (other than an investment entity) that is incorporated or organized under the laws of a possession of the United States.

Returns:

territoryFinancialInstitutionCertification

setTerritoryFinancialInstitutionCertification

public void setTerritoryFinancialInstitutionCertification(Boolean territoryFinancialInstitutionCertification)

exceptedNonfinancialGroupEntityCertification

public W8BenEFormRequest exceptedNonfinancialGroupEntityCertification(Boolean exceptedNonfinancialGroupEntityCertification)

getExceptedNonfinancialGroupEntityCertification
```
@Nullable
public Boolean getExceptedNonfinancialGroupEntityCertification()
```
Certifies that the entity is a holding company, treasury center, or captive finance company operating within a nonfinancial group and not functioning as an investment or financial institution.

Returns:

exceptedNonfinancialGroupEntityCertification

setExceptedNonfinancialGroupEntityCertification

public void setExceptedNonfinancialGroupEntityCertification(Boolean exceptedNonfinancialGroupEntityCertification)

exceptedNonfinancialStartUpCertification

public W8BenEFormRequest exceptedNonfinancialStartUpCertification(Boolean exceptedNonfinancialStartUpCertification)

getExceptedNonfinancialStartUpCertification
```
@Nullable
public Boolean getExceptedNonfinancialStartUpCertification()
```
Certifies that the entity is a recently formed startup NFFE investing in a non-financial business and is not operating as or presenting itself as an investment fund.

Returns:

exceptedNonfinancialStartUpCertification

setExceptedNonfinancialStartUpCertification

public void setExceptedNonfinancialStartUpCertification(Boolean exceptedNonfinancialStartUpCertification)

startupFormationOrResolutionDate

public W8BenEFormRequest startupFormationOrResolutionDate(LocalDate startupFormationOrResolutionDate)

getStartupFormationOrResolutionDate
```
@Nullable
public LocalDate getStartupFormationOrResolutionDate()
```
The date the start-up company was formed on (or, in case of new line of business, the date of board resolution approving the new line of business).

Returns:

startupFormationOrResolutionDate

setStartupFormationOrResolutionDate

public void setStartupFormationOrResolutionDate(LocalDate startupFormationOrResolutionDate)

exceptedNonfinancialEntityInLiquidationOrBankruptcyCertification

public W8BenEFormRequest exceptedNonfinancialEntityInLiquidationOrBankruptcyCertification(Boolean exceptedNonfinancialEntityInLiquidationOrBankruptcyCertification)

getExceptedNonfinancialEntityInLiquidationOrBankruptcyCertification
```
@Nullable
public Boolean getExceptedNonfinancialEntityInLiquidationOrBankruptcyCertification()
```
Certifies that the entity is in liquidation, reorganization, or bankruptcy and intends to operate as a nonfinancial entity, with supporting documentation available if the process exceeds three years.

Returns:

exceptedNonfinancialEntityInLiquidationOrBankruptcyCertification

setExceptedNonfinancialEntityInLiquidationOrBankruptcyCertification

public void setExceptedNonfinancialEntityInLiquidationOrBankruptcyCertification(Boolean exceptedNonfinancialEntityInLiquidationOrBankruptcyCertification)

nonfinancialEntityFilingDate

public W8BenEFormRequest nonfinancialEntityFilingDate(LocalDate nonfinancialEntityFilingDate)

getNonfinancialEntityFilingDate
```
@Nullable
public LocalDate getNonfinancialEntityFilingDate()
```
The filed date for a plan of reorganization, liquidation or bankruptcy.

Returns:

nonfinancialEntityFilingDate

setNonfinancialEntityFilingDate

public void setNonfinancialEntityFilingDate(LocalDate nonfinancialEntityFilingDate)

section501COrganizationCertification

public W8BenEFormRequest section501COrganizationCertification(Boolean section501COrganizationCertification)

getSection501COrganizationCertification
```
@Nullable
public Boolean getSection501COrganizationCertification()
```
Certifies that the entity is a section 501(c) organization based on a valid IRS determination letter or a legal opinion from U.S. counsel.

Returns:

section501COrganizationCertification

setSection501COrganizationCertification

public void setSection501COrganizationCertification(Boolean section501COrganizationCertification)

determinationLetterDate

public W8BenEFormRequest determinationLetterDate(LocalDate determinationLetterDate)

getDeterminationLetterDate
```
@Nullable
public LocalDate getDeterminationLetterDate()
```
The date of the IRS determination letter confirming the entity’s section 501(c) status.

Returns:

determinationLetterDate

setDeterminationLetterDate

public void setDeterminationLetterDate(LocalDate determinationLetterDate)

nonprofitOrganizationCertification

public W8BenEFormRequest nonprofitOrganizationCertification(Boolean nonprofitOrganizationCertification)

getNonprofitOrganizationCertification
```
@Nullable
public Boolean getNonprofitOrganizationCertification()
```
Certifies that the entity is a nonprofit organization established for charitable or similar purposes, exempt from income tax, and restricted in the use and distribution of its assets under applicable law.

Returns:

nonprofitOrganizationCertification

setNonprofitOrganizationCertification

public void setNonprofitOrganizationCertification(Boolean nonprofitOrganizationCertification)

publiclyTradedNffeCertification

public W8BenEFormRequest publiclyTradedNffeCertification(Boolean publiclyTradedNffeCertification)

getPubliclyTradedNffeCertification
```
@Nullable
public Boolean getPubliclyTradedNffeCertification()
```
Certifies that the entity is a foreign corporation that is not a financial institution and whose stock is regularly traded on an established securities market.

Returns:

publiclyTradedNffeCertification

setPubliclyTradedNffeCertification

public void setPubliclyTradedNffeCertification(Boolean publiclyTradedNffeCertification)

publiclyTradedNffeSecuritiesMarket

public W8BenEFormRequest publiclyTradedNffeSecuritiesMarket(String publiclyTradedNffeSecuritiesMarket)

getPubliclyTradedNffeSecuritiesMarket
```
@Nullable
public String getPubliclyTradedNffeSecuritiesMarket()
```
The name of the securities market where the corporation's stock is regularly traded.

Returns:

publiclyTradedNffeSecuritiesMarket

setPubliclyTradedNffeSecuritiesMarket

public void setPubliclyTradedNffeSecuritiesMarket(String publiclyTradedNffeSecuritiesMarket)

nffeAffiliateOfPubliclyTradedEntityCertification

public W8BenEFormRequest nffeAffiliateOfPubliclyTradedEntityCertification(Boolean nffeAffiliateOfPubliclyTradedEntityCertification)

getNffeAffiliateOfPubliclyTradedEntityCertification
```
@Nullable
public Boolean getNffeAffiliateOfPubliclyTradedEntityCertification()
```
Certifies that the entity is a foreign corporation that is not a financial institution and is affiliated with a publicly traded entity within the same expanded affiliated group.

Returns:

nffeAffiliateOfPubliclyTradedEntityCertification

setNffeAffiliateOfPubliclyTradedEntityCertification

public void setNffeAffiliateOfPubliclyTradedEntityCertification(Boolean nffeAffiliateOfPubliclyTradedEntityCertification)

publiclyTradedEntity

public W8BenEFormRequest publiclyTradedEntity(String publiclyTradedEntity)

getPubliclyTradedEntity
```
@Nullable
public String getPubliclyTradedEntity()
```
The name of the affiliated entity whose stock is regularly traded on an established securities market.

Returns:

publiclyTradedEntity

setPubliclyTradedEntity

public void setPubliclyTradedEntity(String publiclyTradedEntity)

nffeAffiliateOfPubliclyTradedEntitySecuritiesMarket

public W8BenEFormRequest nffeAffiliateOfPubliclyTradedEntitySecuritiesMarket(String nffeAffiliateOfPubliclyTradedEntitySecuritiesMarket)

getNffeAffiliateOfPubliclyTradedEntitySecuritiesMarket
```
@Nullable
public String getNffeAffiliateOfPubliclyTradedEntitySecuritiesMarket()
```
The name of the established securities market where the affiliated entity's stock is traded.

Returns:

nffeAffiliateOfPubliclyTradedEntitySecuritiesMarket

setNffeAffiliateOfPubliclyTradedEntitySecuritiesMarket

public void setNffeAffiliateOfPubliclyTradedEntitySecuritiesMarket(String nffeAffiliateOfPubliclyTradedEntitySecuritiesMarket)

exceptedTerritoryNffeCertification

public W8BenEFormRequest exceptedTerritoryNffeCertification(Boolean exceptedTerritoryNffeCertification)

getExceptedTerritoryNffeCertification
```
@Nullable
public Boolean getExceptedTerritoryNffeCertification()
```
Certifies that the entity is organized in a U.S. possession, is not engaged in financial activities, and is entirely owned by bona fide residents of that possession.

Returns:

exceptedTerritoryNffeCertification

setExceptedTerritoryNffeCertification

public void setExceptedTerritoryNffeCertification(Boolean exceptedTerritoryNffeCertification)

activeNffeCertification

public W8BenEFormRequest activeNffeCertification(Boolean activeNffeCertification)

getActiveNffeCertification
```
@Nullable
public Boolean getActiveNffeCertification()
```
Certifies that the entity is a foreign non-financial institution with less than 50% passive income and less than 50% of its assets producing or held to produce passive income.

Returns:

activeNffeCertification

setActiveNffeCertification

public void setActiveNffeCertification(Boolean activeNffeCertification)

passiveNffeCertification

public W8BenEFormRequest passiveNffeCertification(Boolean passiveNffeCertification)

getPassiveNffeCertification
```
@Nullable
public Boolean getPassiveNffeCertification()
```
Certifies that the entity is a foreign non-financial entity that does not qualify for any other NFFE category and is not a financial institution.

Returns:

passiveNffeCertification

setPassiveNffeCertification

public void setPassiveNffeCertification(Boolean passiveNffeCertification)

passiveNffeNoSubstantialUsOwnersCertification

public W8BenEFormRequest passiveNffeNoSubstantialUsOwnersCertification(Boolean passiveNffeNoSubstantialUsOwnersCertification)

getPassiveNffeNoSubstantialUsOwnersCertification
```
@Nullable
public Boolean getPassiveNffeNoSubstantialUsOwnersCertification()
```
Certifies that the passive NFFE has no substantial U.S. owners or controlling U.S. persons.

Returns:

passiveNffeNoSubstantialUsOwnersCertification

setPassiveNffeNoSubstantialUsOwnersCertification

public void setPassiveNffeNoSubstantialUsOwnersCertification(Boolean passiveNffeNoSubstantialUsOwnersCertification)

passiveNffeSubstantialUsOwnersProvidedCertification

public W8BenEFormRequest passiveNffeSubstantialUsOwnersProvidedCertification(Boolean passiveNffeSubstantialUsOwnersProvidedCertification)

getPassiveNffeSubstantialUsOwnersProvidedCertification
```
@Nullable
public Boolean getPassiveNffeSubstantialUsOwnersProvidedCertification()
```
Certifies that the passive NFFE has provided the name, address, and TIN of each substantial U.S. owner or controlling U.S. person.

Returns:

passiveNffeSubstantialUsOwnersProvidedCertification

setPassiveNffeSubstantialUsOwnersProvidedCertification

public void setPassiveNffeSubstantialUsOwnersProvidedCertification(Boolean passiveNffeSubstantialUsOwnersProvidedCertification)

exceptedInterAffiliateFfiCertification

public W8BenEFormRequest exceptedInterAffiliateFfiCertification(Boolean exceptedInterAffiliateFfiCertification)

getExceptedInterAffiliateFfiCertification
```
@Nullable
public Boolean getExceptedInterAffiliateFfiCertification()
```
Certifies that the entity is an inter-affiliate FFI meeting all conditions for exemption, including limited account activity and payment interactions within its expanded affiliated group.

Returns:

exceptedInterAffiliateFfiCertification

setExceptedInterAffiliateFfiCertification

public void setExceptedInterAffiliateFfiCertification(Boolean exceptedInterAffiliateFfiCertification)

sponsoredDirectReportingNffeCertification

public W8BenEFormRequest sponsoredDirectReportingNffeCertification(Boolean sponsoredDirectReportingNffeCertification)

getSponsoredDirectReportingNffeCertification
```
@Nullable
public Boolean getSponsoredDirectReportingNffeCertification()
```
Certifies that the entity is a sponsored direct reporting NFFE.

Returns:

sponsoredDirectReportingNffeCertification

setSponsoredDirectReportingNffeCertification

public void setSponsoredDirectReportingNffeCertification(Boolean sponsoredDirectReportingNffeCertification)

directReportingNffeSponsoringEntity

public W8BenEFormRequest directReportingNffeSponsoringEntity(String directReportingNffeSponsoringEntity)

getDirectReportingNffeSponsoringEntity
```
@Nullable
public String getDirectReportingNffeSponsoringEntity()
```
The name of the entity that sponsors the direct reporting NFFE.

Returns:

directReportingNffeSponsoringEntity

setDirectReportingNffeSponsoringEntity

public void setDirectReportingNffeSponsoringEntity(String directReportingNffeSponsoringEntity)

substantialUsOwners

public W8BenEFormRequest substantialUsOwners(List<SubstantialUsOwnerRequest> substantialUsOwners)

addSubstantialUsOwnersItem

public W8BenEFormRequest addSubstantialUsOwnersItem(SubstantialUsOwnerRequest substantialUsOwnersItem)

getSubstantialUsOwners
```
@Nullable
public List<SubstantialUsOwnerRequest> getSubstantialUsOwners()
```
The list of substantial U.S. owners of passive NFFE.

Returns:

substantialUsOwners

setSubstantialUsOwners

public void setSubstantialUsOwners(List<SubstantialUsOwnerRequest> substantialUsOwners)

signerName

public W8BenEFormRequest signerName(String signerName)

getSignerName
```
@Nullable
public String getSignerName()
```
The name of the signer.

Returns:

signerName

setSignerName

public void setSignerName(String signerName)

capacityToSignCertification

public W8BenEFormRequest capacityToSignCertification(Boolean capacityToSignCertification)

getCapacityToSignCertification
```
@Nullable
public Boolean getCapacityToSignCertification()
```
Certifies signer has the capacity to sign for the beneficial owner.

Returns:

capacityToSignCertification

setCapacityToSignCertification

public void setCapacityToSignCertification(Boolean capacityToSignCertification)

eDeliveryConsentedAt

public W8BenEFormRequest eDeliveryConsentedAt(OffsetDateTime eDeliveryConsentedAt)

geteDeliveryConsentedAt
```
@Nullable
public OffsetDateTime geteDeliveryConsentedAt()
```
The date when e-delivery was consented.

Returns:

eDeliveryConsentedAt

seteDeliveryConsentedAt

public void seteDeliveryConsentedAt(OffsetDateTime eDeliveryConsentedAt)

signature

public W8BenEFormRequest signature(String signature)

getSignature
```
@Nullable
public String getSignature()
```
The signature of the form.

Returns:

signature

setSignature

public void setSignature(String signature)

companyId

public W8BenEFormRequest companyId(String companyId)

getCompanyId
```
@Nonnull
public String getCompanyId()
```
The ID of the associated company.

Returns:

companyId

setCompanyId

public void setCompanyId(String companyId)

referenceId

public W8BenEFormRequest referenceId(String referenceId)

getReferenceId
```
@Nullable
public String getReferenceId()
```
A reference identifier for the form.

Returns:

referenceId

setReferenceId

public void setReferenceId(String referenceId)

email

public W8BenEFormRequest email(String email)

getEmail
```
@Nullable
public String getEmail()
```
The email address of the individual associated with the form.

Returns:

email

setEmail

public void setEmail(String email)

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 W8BenEFormRequest

fromJson
```
public static W8BenEFormRequest fromJson(String jsonString)
                                  throws IOException
```
Create an instance of W8BenEFormRequest given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of W8BenEFormRequest

Throws:

IOException - if the JSON string is invalid with respect to W8BenEFormRequest

toJson
```
public String toJson()
```
Convert an instance of W8BenEFormRequest to an JSON string

Returns:

JSON string

Constructor	Description
`W8BenEFormRequest()`
`W8BenEFormRequest(W8BenEFormRequest.TypeEnum type)`

Class W8BenEFormRequest

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_TYPE

SERIALIZED_NAME_NAME

SERIALIZED_NAME_CITIZENSHIP_COUNTRY

SERIALIZED_NAME_DISREGARDED_ENTITY

SERIALIZED_NAME_ENTITY_TYPE

SERIALIZED_NAME_MAKING_TREATY_CLAIM

SERIALIZED_NAME_FATCA_STATUS

SERIALIZED_NAME_RESIDENCE_ADDRESS

SERIALIZED_NAME_RESIDENCE_CITY

SERIALIZED_NAME_RESIDENCE_STATE

SERIALIZED_NAME_RESIDENCE_ZIP

SERIALIZED_NAME_RESIDENCE_COUNTRY

SERIALIZED_NAME_RESIDENCE_IS_MAILING

SERIALIZED_NAME_MAILING_ADDRESS

SERIALIZED_NAME_MAILING_CITY

SERIALIZED_NAME_MAILING_STATE

SERIALIZED_NAME_MAILING_ZIP

SERIALIZED_NAME_MAILING_COUNTRY

SERIALIZED_NAME_TIN

SERIALIZED_NAME_GIIN

SERIALIZED_NAME_FOREIGN_TIN_NOT_REQUIRED

SERIALIZED_NAME_FOREIGN_TIN

SERIALIZED_NAME_REFERENCE_NUMBER

SERIALIZED_NAME_DISREGARDED_ENTITY_FATCA_STATUS

SERIALIZED_NAME_DISREGARDED_ADDRESS

SERIALIZED_NAME_DISREGARDED_CITY

SERIALIZED_NAME_DISREGARDED_STATE

SERIALIZED_NAME_DISREGARDED_ZIP

SERIALIZED_NAME_DISREGARDED_COUNTRY

SERIALIZED_NAME_DISREGARDED_ENTITY_GIIN

SERIALIZED_NAME_TREATY_COUNTRY_CERTIFICATION

SERIALIZED_NAME_TREATY_COUNTRY

SERIALIZED_NAME_BENEFIT_LIMITATION_CERTIFICATION

SERIALIZED_NAME_BENEFIT_LIMITATION

SERIALIZED_NAME_QUALIFIED_RESIDENT_STATUS_CERTIFICATION

SERIALIZED_NAME_TREATY_ARTICLE

SERIALIZED_NAME_WITHHOLDING_RATE

SERIALIZED_NAME_INCOME_TYPE

SERIALIZED_NAME_TREATY_REASONS

SERIALIZED_NAME_FFI_SPONSORING_ENTITY

SERIALIZED_NAME_INVESTMENT_ENTITY_CERTIFICATION

SERIALIZED_NAME_CONTROLLED_FOREIGN_CORPORATION_CERTIFICATION

SERIALIZED_NAME_COMPLIANT_NONREGISTERING_LOCAL_BANK_CERTIFICATION

SERIALIZED_NAME_COMPLIANT_FFI_LOW_VALUE_ACCOUNTS_CERTIFICATION

SERIALIZED_NAME_SPONSORED_CLOSELY_HELD_ENTITY_SPONSORING_ENTITY

SERIALIZED_NAME_SPONSORED_CLOSELY_HELD_INVESTMENT_VEHICLE_CERTIFICATION

SERIALIZED_NAME_COMPLIANT_LIMITED_LIFE_DEBT_ENTITY_CERTIFICATION

SERIALIZED_NAME_INVESTMENT_ENTITY_NO_FINANCIAL_ACCOUNTS_CERTIFICATION

SERIALIZED_NAME_OWNER_DOCUMENTED_FFI_CERTIFICATION

SERIALIZED_NAME_OWNER_DOCUMENTED_FFI_REPORTING_STATEMENT_CERTIFICATION

SERIALIZED_NAME_OWNER_DOCUMENTED_FFI_AUDITOR_LETTER_CERTIFICATION

SERIALIZED_NAME_OWNER_DOCUMENTED_FFI_TRUST_BENEFICIARIES_CERTIFICATION

SERIALIZED_NAME_RESTRICTED_DISTRIBUTOR_CERTIFICATION

SERIALIZED_NAME_RESTRICTED_DISTRIBUTOR_AGREEMENT_CERTIFICATION

SERIALIZED_NAME_RESTRICTED_DISTRIBUTOR_PREEXISTING_SALES_COMPLIANCE_CERTIFICATION

SERIALIZED_NAME_NONREPORTING_IGA_FFI_CERTIFICATION

SERIALIZED_NAME_IGA_COUNTRY

SERIALIZED_NAME_IGA_MODEL

SERIALIZED_NAME_IGA_LEGAL_STATUS_TREATMENT

SERIALIZED_NAME_IGA_FFI_TRUSTEE_OR_SPONSOR

SERIALIZED_NAME_IGA_FFI_TRUSTEE_IS_FOREIGN

SERIALIZED_NAME_NON_COMMERCIAL_FINANCIAL_ACTIVITY_CERTIFICATION

SERIALIZED_NAME_INTERNATION_ORGANIZATION_CERTIFICATION

SERIALIZED_NAME_INTERGOVERNMENTAL_ORGANIZATION_CERTIFICATION

SERIALIZED_NAME_TREATY_QUALIFIED_PENSION_FUND_CERTIFICATION

SERIALIZED_NAME_QUALIFIED_RETIREMENT_FUND_CERTIFICATION

SERIALIZED_NAME_NARROW_PARTICIPATION_RETIREMENT_FUND_CERTIFICATION

SERIALIZED_NAME_SECTION401_A_EQUIVALENT_PENSION_PLAN_CERTIFICATION

SERIALIZED_NAME_INVESTMENT_ENTITY_FOR_RETIREMENT_FUNDS_CERTIFICATION

SERIALIZED_NAME_EXEMPT_BENEFICIAL_OWNER_SPONSORED_RETIREMENT_FUND_CERTIFICATION

SERIALIZED_NAME_EXEMPT_BENEFICIAL_OWNER_OWNED_INVESTMENT_ENTITY_CERTIFICATION

SERIALIZED_NAME_TERRITORY_FINANCIAL_INSTITUTION_CERTIFICATION

SERIALIZED_NAME_EXCEPTED_NONFINANCIAL_GROUP_ENTITY_CERTIFICATION