Class W8ImyFormRequest


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

      • SERIALIZED_NAME_RESIDENCE_IS_MAILING

        public static final String SERIALIZED_NAME_RESIDENCE_IS_MAILING
        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_ENTITY_GIIN

        public static final String SERIALIZED_NAME_DISREGARDED_ENTITY_GIIN
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_QUALIFIED_INTERMEDIARY_CERTIFICATION

        public static final String SERIALIZED_NAME_QUALIFIED_INTERMEDIARY_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_QI_PRIMARY_WITHHOLDING_RESPONSIBILITY_CERTIFICATION

        public static final String SERIALIZED_NAME_QI_PRIMARY_WITHHOLDING_RESPONSIBILITY_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_QI_WITHHOLDING_RESPONSIBILITY_FOR_PTP_SALES_CERTIFICATION

        public static final String SERIALIZED_NAME_QI_WITHHOLDING_RESPONSIBILITY_FOR_PTP_SALES_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_QI_NOMINEE_WITHHOLDING_RESPONSIBILITY_FOR_PTP_DISTRIBUTIONS_CERTIFICATION

        public static final String SERIALIZED_NAME_QI_NOMINEE_WITHHOLDING_RESPONSIBILITY_FOR_PTP_DISTRIBUTIONS_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_QI_SECURITIES_LENDER_SUBSTITUTE_DIVIDEND_WITHHOLDING_CERTIFICATION

        public static final String SERIALIZED_NAME_QI_SECURITIES_LENDER_SUBSTITUTE_DIVIDEND_WITHHOLDING_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_QI_WITHHOLDING_AND1099_REPORTING_RESPONSIBILITY_CERTIFICATION

        public static final String SERIALIZED_NAME_QI_WITHHOLDING_AND1099_REPORTING_RESPONSIBILITY_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_QI_FORM1099_OR_FATCA_REPORTING_RESPONSIBILITY_CERTIFICATION

        public static final String SERIALIZED_NAME_QI_FORM1099_OR_FATCA_REPORTING_RESPONSIBILITY_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_QI_OPT_OUT_OF_FORM1099_REPORTING_CERTIFICATION

        public static final String SERIALIZED_NAME_QI_OPT_OUT_OF_FORM1099_REPORTING_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_QI_WITHHOLDING_RATE_POOL_CERTIFICATION

        public static final String SERIALIZED_NAME_QI_WITHHOLDING_RATE_POOL_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_QI_INTERMEDIARY_OR_FLOW_THROUGH_ENTITY_DOCUMENTATION_CERTIFICATION

        public static final String SERIALIZED_NAME_QI_INTERMEDIARY_OR_FLOW_THROUGH_ENTITY_DOCUMENTATION_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_QUALIFIED_DERIVATIVES_DEALER_CERTIFICATION

        public static final String SERIALIZED_NAME_QUALIFIED_DERIVATIVES_DEALER_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_QDD_DISREGARDED_ENTITY

        public static final String SERIALIZED_NAME_QDD_DISREGARDED_ENTITY
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_NONQUALIFIED_INTERMEDIARY_CERTIFICATION

        public static final String SERIALIZED_NAME_NONQUALIFIED_INTERMEDIARY_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_NQI_WITHHOLDING_STATEMENT_TRANSMISSION_CERTIFICATION

        public static final String SERIALIZED_NAME_NQI_WITHHOLDING_STATEMENT_TRANSMISSION_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_NQI_WITHHOLDING_RATE_POOL_COMPLIANCE_CERTIFICATION

        public static final String SERIALIZED_NAME_NQI_WITHHOLDING_RATE_POOL_COMPLIANCE_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_NQI_QUALIFIED_SECURITIES_LENDER_CERTIFICATION

        public static final String SERIALIZED_NAME_NQI_QUALIFIED_SECURITIES_LENDER_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_NQI_ALTERNATIVE_WITHHOLDING_STATEMENT_VERIFICATION_CERTIFICATION

        public static final String SERIALIZED_NAME_NQI_ALTERNATIVE_WITHHOLDING_STATEMENT_VERIFICATION_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_TFI_TREATED_AS_US_PERSON_CERTIFICATION

        public static final String SERIALIZED_NAME_TFI_TREATED_AS_US_PERSON_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_TFI_WITHHOLDING_STATEMENT_TRANSMISSION_CERTIFICATION

        public static final String SERIALIZED_NAME_TFI_WITHHOLDING_STATEMENT_TRANSMISSION_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_TFI_TREATED_AS_US_PERSON_FOR_PTP_SALES_CERTIFICATION

        public static final String SERIALIZED_NAME_TFI_TREATED_AS_US_PERSON_FOR_PTP_SALES_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_TFI_NOMINEE_US_PERSON_FOR_PTP_DISTRIBUTIONS_CERTIFICATION

        public static final String SERIALIZED_NAME_TFI_NOMINEE_US_PERSON_FOR_PTP_DISTRIBUTIONS_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_TFI_NOT_NOMINEE_FOR_PTP_DISTRIBUTIONS_CERTIFICATION

        public static final String SERIALIZED_NAME_TFI_NOT_NOMINEE_FOR_PTP_DISTRIBUTIONS_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_US_BRANCH_NON_EFFECTIVELY_CONNECTED_INCOME_CERTIFICATION

        public static final String SERIALIZED_NAME_US_BRANCH_NON_EFFECTIVELY_CONNECTED_INCOME_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_US_BRANCH_AGREEMENT_TO_BE_TREATED_AS_US_PERSON_CERTIFICATION

        public static final String SERIALIZED_NAME_US_BRANCH_AGREEMENT_TO_BE_TREATED_AS_US_PERSON_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_US_BRANCH_WITHHOLDING_STATEMENT_AND_COMPLIANCE_CERTIFICATION

        public static final String SERIALIZED_NAME_US_BRANCH_WITHHOLDING_STATEMENT_AND_COMPLIANCE_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_US_BRANCH_ACTING_AS_US_PERSON_FOR_PTP_SALES_CERTIFICATION

        public static final String SERIALIZED_NAME_US_BRANCH_ACTING_AS_US_PERSON_FOR_PTP_SALES_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_US_BRANCH_NOMINEE_FOR_PTP_DISTRIBUTIONS_CERTIFICATION

        public static final String SERIALIZED_NAME_US_BRANCH_NOMINEE_FOR_PTP_DISTRIBUTIONS_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_US_BRANCH_NOT_NOMINEE_FOR_PTP_DISTRIBUTIONS_CERTIFICATION

        public static final String SERIALIZED_NAME_US_BRANCH_NOT_NOMINEE_FOR_PTP_DISTRIBUTIONS_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_WITHHOLDING_FOREIGN_PARTNERSHIP_OR_TRUST_CERTIFICATION

        public static final String SERIALIZED_NAME_WITHHOLDING_FOREIGN_PARTNERSHIP_OR_TRUST_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_NONWITHHOLDING_FOREIGN_ENTITY_WITHHOLDING_STATEMENT_CERTIFICATION

        public static final String SERIALIZED_NAME_NONWITHHOLDING_FOREIGN_ENTITY_WITHHOLDING_STATEMENT_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_FOREIGN_ENTITY_PARTNER_IN_LOWER_TIER_PARTNERSHIP_CERTIFICATION

        public static final String SERIALIZED_NAME_FOREIGN_ENTITY_PARTNER_IN_LOWER_TIER_PARTNERSHIP_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_FOREIGN_PARTNERSHIP_AMOUNT_REALIZED_SECTION1446_F_CERTIFICATION

        public static final String SERIALIZED_NAME_FOREIGN_PARTNERSHIP_AMOUNT_REALIZED_SECTION1446_F_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_FOREIGN_PARTNERSHIP_MODIFIED_AMOUNT_REALIZED_CERTIFICATION

        public static final String SERIALIZED_NAME_FOREIGN_PARTNERSHIP_MODIFIED_AMOUNT_REALIZED_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_FOREIGN_GRANTOR_TRUST_AMOUNT_REALIZED_ALLOCATION_CERTIFICATION

        public static final String SERIALIZED_NAME_FOREIGN_GRANTOR_TRUST_AMOUNT_REALIZED_ALLOCATION_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_ALTERNATIVE_WITHHOLDING_STATEMENT_RELIANCE_CERTIFICATION

        public static final String SERIALIZED_NAME_ALTERNATIVE_WITHHOLDING_STATEMENT_RELIANCE_CERTIFICATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_NP_FFI_WITH_EXEMPT_BENEFICIAL_OWNERS_CERTIFICATION

        public static final String SERIALIZED_NAME_NP_FFI_WITH_EXEMPT_BENEFICIAL_OWNERS_CERTIFICATION
        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_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_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_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_FOREIGN_CENTRAL_BANK_OF_ISSUE_CERTIFICATION

        public static final String SERIALIZED_NAME_FOREIGN_CENTRAL_BANK_OF_ISSUE_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_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_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_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_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_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_E_DELIVERY_CONSENTED_AT

        public static final String SERIALIZED_NAME_E_DELIVERY_CONSENTED_AT
        See Also:
        Constant Field Values
      • openapiRequiredFields

        public static HashSet<String> openapiRequiredFields
    • Constructor Detail

      • W8ImyFormRequest

        public W8ImyFormRequest()
    • Method Detail

      • getName

        @Nullable
        public String getName()
        The name of the individual or entity associated with the form.
        Returns:
        name
      • setName

        public void setName​(String name)
      • getCitizenshipCountry

        @Nullable
        public String getCitizenshipCountry()
        The country of citizenship.
        Returns:
        citizenshipCountry
      • setCitizenshipCountry

        public void setCitizenshipCountry​(String citizenshipCountry)
      • getDisregardedEntity

        @Nullable
        public String getDisregardedEntity()
        The name of the disregarded entity receiving the payment (if applicable).
        Returns:
        disregardedEntity
      • setDisregardedEntity

        public void setDisregardedEntity​(String disregardedEntity)
      • getEntityType

        @Nullable
        public String getEntityType()
        The entity type.
        Returns:
        entityType
      • setEntityType

        public void setEntityType​(String entityType)
      • getFatcaStatus

        @Nullable
        public String getFatcaStatus()
        The FATCA status.
        Returns:
        fatcaStatus
      • setFatcaStatus

        public void setFatcaStatus​(String fatcaStatus)
      • getResidenceAddress

        @Nullable
        public String getResidenceAddress()
        The residential address of the individual or entity.
        Returns:
        residenceAddress
      • setResidenceAddress

        public void setResidenceAddress​(String residenceAddress)
      • getResidenceCity

        @Nullable
        public String getResidenceCity()
        The city of residence.
        Returns:
        residenceCity
      • setResidenceCity

        public void setResidenceCity​(String residenceCity)
      • getResidenceState

        @Nullable
        public String getResidenceState()
        The state of residence.
        Returns:
        residenceState
      • setResidenceState

        public void setResidenceState​(String residenceState)
      • getResidenceZip

        @Nullable
        public String getResidenceZip()
        The ZIP code of the residence.
        Returns:
        residenceZip
      • setResidenceZip

        public void setResidenceZip​(String residenceZip)
      • getResidenceCountry

        @Nullable
        public String getResidenceCountry()
        The country of residence.
        Returns:
        residenceCountry
      • setResidenceCountry

        public void setResidenceCountry​(String residenceCountry)
      • getResidenceIsMailing

        @Nullable
        public Boolean getResidenceIsMailing()
        Indicates whether the residence address is also the mailing address.
        Returns:
        residenceIsMailing
      • setResidenceIsMailing

        public void setResidenceIsMailing​(Boolean residenceIsMailing)
      • getMailingAddress

        @Nullable
        public String getMailingAddress()
        The mailing address.
        Returns:
        mailingAddress
      • setMailingAddress

        public void setMailingAddress​(String mailingAddress)
      • getMailingCity

        @Nullable
        public String getMailingCity()
        The city of the mailing address.
        Returns:
        mailingCity
      • setMailingCity

        public void setMailingCity​(String mailingCity)
      • getMailingState

        @Nullable
        public String getMailingState()
        The state of the mailing address.
        Returns:
        mailingState
      • setMailingState

        public void setMailingState​(String mailingState)
      • getMailingZip

        @Nullable
        public String getMailingZip()
        The ZIP code of the mailing address.
        Returns:
        mailingZip
      • setMailingZip

        public void setMailingZip​(String mailingZip)
      • getMailingCountry

        @Nullable
        public String getMailingCountry()
        The country of the mailing address.
        Returns:
        mailingCountry
      • setMailingCountry

        public void setMailingCountry​(String mailingCountry)
      • getTinType

        @Nullable
        public String getTinType()
        The type of TIN provided.
        Returns:
        tinType
      • setTinType

        public void setTinType​(String tinType)
      • getTin

        @Nullable
        public String getTin()
        The taxpayer identification number (TIN).
        Returns:
        tin
      • setTin

        public void setTin​(String tin)
      • getGiin

        @Nullable
        public String getGiin()
        The global intermediary identification number (GIIN).
        Returns:
        giin
      • setGiin

        public void setGiin​(String giin)
      • getForeignTin

        @Nullable
        public String getForeignTin()
        The foreign taxpayer identification number (TIN).
        Returns:
        foreignTin
      • setForeignTin

        public void setForeignTin​(String foreignTin)
      • getReferenceNumber

        @Nullable
        public String getReferenceNumber()
        A reference number for the form.
        Returns:
        referenceNumber
      • setReferenceNumber

        public void setReferenceNumber​(String referenceNumber)
      • disregardedEntityFatcaStatus

        public W8ImyFormRequest 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)
      • getDisregardedAddress

        @Nullable
        public String getDisregardedAddress()
        The address for disregarded entities.
        Returns:
        disregardedAddress
      • setDisregardedAddress

        public void setDisregardedAddress​(String disregardedAddress)
      • getDisregardedCity

        @Nullable
        public String getDisregardedCity()
        The city for disregarded entities.
        Returns:
        disregardedCity
      • setDisregardedCity

        public void setDisregardedCity​(String disregardedCity)
      • getDisregardedState

        @Nullable
        public String getDisregardedState()
        The state for disregarded entities.
        Returns:
        disregardedState
      • setDisregardedState

        public void setDisregardedState​(String disregardedState)
      • getDisregardedZip

        @Nullable
        public String getDisregardedZip()
        The ZIP code for disregarded entities.
        Returns:
        disregardedZip
      • setDisregardedZip

        public void setDisregardedZip​(String disregardedZip)
      • getDisregardedCountry

        @Nullable
        public String getDisregardedCountry()
        The country for disregarded entities.
        Returns:
        disregardedCountry
      • setDisregardedCountry

        public void setDisregardedCountry​(String disregardedCountry)
      • getDisregardedEntityGiin

        @Nullable
        public String getDisregardedEntityGiin()
        The GIIN for disregarded entities.
        Returns:
        disregardedEntityGiin
      • setDisregardedEntityGiin

        public void setDisregardedEntityGiin​(String disregardedEntityGiin)
      • qualifiedIntermediaryCertification

        public W8ImyFormRequest qualifiedIntermediaryCertification​(Boolean qualifiedIntermediaryCertification)
      • getQualifiedIntermediaryCertification

        @Nullable
        public Boolean getQualifiedIntermediaryCertification()
        Certifies that the entity is a Qualified Intermediary (QI) acting in accordance with its QI Agreement, providing required withholding statements and documentation for relevant tax withholding purposes.
        Returns:
        qualifiedIntermediaryCertification
      • setQualifiedIntermediaryCertification

        public void setQualifiedIntermediaryCertification​(Boolean qualifiedIntermediaryCertification)
      • qiPrimaryWithholdingResponsibilityCertification

        public W8ImyFormRequest qiPrimaryWithholdingResponsibilityCertification​(Boolean qiPrimaryWithholdingResponsibilityCertification)
      • getQiPrimaryWithholdingResponsibilityCertification

        @Nullable
        public Boolean getQiPrimaryWithholdingResponsibilityCertification()
        Certifies that the Qualified Intermediary assumes primary withholding responsibility under chapters 3 and 4 for the specified accounts.
        Returns:
        qiPrimaryWithholdingResponsibilityCertification
      • setQiPrimaryWithholdingResponsibilityCertification

        public void setQiPrimaryWithholdingResponsibilityCertification​(Boolean qiPrimaryWithholdingResponsibilityCertification)
      • qiWithholdingResponsibilityForPtpSalesCertification

        public W8ImyFormRequest qiWithholdingResponsibilityForPtpSalesCertification​(Boolean qiWithholdingResponsibilityForPtpSalesCertification)
      • getQiWithholdingResponsibilityForPtpSalesCertification

        @Nullable
        public Boolean getQiWithholdingResponsibilityForPtpSalesCertification()
        Certifies that the Qualified Intermediary assumes primary withholding and reporting responsibility under section 1446(f) for amounts realized from sales of interests in publicly traded partnerships.
        Returns:
        qiWithholdingResponsibilityForPtpSalesCertification
      • setQiWithholdingResponsibilityForPtpSalesCertification

        public void setQiWithholdingResponsibilityForPtpSalesCertification​(Boolean qiWithholdingResponsibilityForPtpSalesCertification)
      • qiNomineeWithholdingResponsibilityForPtpDistributionsCertification

        public W8ImyFormRequest qiNomineeWithholdingResponsibilityForPtpDistributionsCertification​(Boolean qiNomineeWithholdingResponsibilityForPtpDistributionsCertification)
      • getQiNomineeWithholdingResponsibilityForPtpDistributionsCertification

        @Nullable
        public Boolean getQiNomineeWithholdingResponsibilityForPtpDistributionsCertification()
        Certifies that the Qualified Intermediary assumes primary withholding responsibility as a nominee under Regulations section 1.1446-4(b)(3) for publicly traded partnership distributions.
        Returns:
        qiNomineeWithholdingResponsibilityForPtpDistributionsCertification
      • setQiNomineeWithholdingResponsibilityForPtpDistributionsCertification

        public void setQiNomineeWithholdingResponsibilityForPtpDistributionsCertification​(Boolean qiNomineeWithholdingResponsibilityForPtpDistributionsCertification)
      • qiSecuritiesLenderSubstituteDividendWithholdingCertification

        public W8ImyFormRequest qiSecuritiesLenderSubstituteDividendWithholdingCertification​(Boolean qiSecuritiesLenderSubstituteDividendWithholdingCertification)
      • getQiSecuritiesLenderSubstituteDividendWithholdingCertification

        @Nullable
        public Boolean getQiSecuritiesLenderSubstituteDividendWithholdingCertification()
        Certifies that the Qualified Intermediary is acting as a qualified securities lender and assumes primary withholding and reporting responsibilities for U.S. source substitute dividend payments.
        Returns:
        qiSecuritiesLenderSubstituteDividendWithholdingCertification
      • setQiSecuritiesLenderSubstituteDividendWithholdingCertification

        public void setQiSecuritiesLenderSubstituteDividendWithholdingCertification​(Boolean qiSecuritiesLenderSubstituteDividendWithholdingCertification)
      • qiWithholdingAnd1099ReportingResponsibilityCertification

        public W8ImyFormRequest qiWithholdingAnd1099ReportingResponsibilityCertification​(Boolean qiWithholdingAnd1099ReportingResponsibilityCertification)
      • getQiWithholdingAnd1099ReportingResponsibilityCertification

        @Nullable
        public Boolean getQiWithholdingAnd1099ReportingResponsibilityCertification()
        Certifies that the Qualified Intermediary assumes primary withholding under chapters 3 and 4, and primary Form 1099 reporting and backup withholding responsibility for U.S. source interest and substitute interest payments.
        Returns:
        qiWithholdingAnd1099ReportingResponsibilityCertification
      • setQiWithholdingAnd1099ReportingResponsibilityCertification

        public void setQiWithholdingAnd1099ReportingResponsibilityCertification​(Boolean qiWithholdingAnd1099ReportingResponsibilityCertification)
      • qiForm1099OrFatcaReportingResponsibilityCertification

        public W8ImyFormRequest qiForm1099OrFatcaReportingResponsibilityCertification​(Boolean qiForm1099OrFatcaReportingResponsibilityCertification)
      • getQiForm1099OrFatcaReportingResponsibilityCertification

        @Nullable
        public Boolean getQiForm1099OrFatcaReportingResponsibilityCertification()
        Certifies that the Qualified Intermediary assumes Form 1099 reporting and backup withholding responsibility, or FATCA reporting responsibility as a participating or registered deemed-compliant FFI, for accounts held by specified U.S. persons.
        Returns:
        qiForm1099OrFatcaReportingResponsibilityCertification
      • setQiForm1099OrFatcaReportingResponsibilityCertification

        public void setQiForm1099OrFatcaReportingResponsibilityCertification​(Boolean qiForm1099OrFatcaReportingResponsibilityCertification)
      • qiOptOutOfForm1099ReportingCertification

        public W8ImyFormRequest qiOptOutOfForm1099ReportingCertification​(Boolean qiOptOutOfForm1099ReportingCertification)
      • getQiOptOutOfForm1099ReportingCertification

        @Nullable
        public Boolean getQiOptOutOfForm1099ReportingCertification()
        Certifies that the Qualified Intermediary does not assume primary Form 1099 reporting and backup withholding responsibility for the accounts associated with this form.
        Returns:
        qiOptOutOfForm1099ReportingCertification
      • setQiOptOutOfForm1099ReportingCertification

        public void setQiOptOutOfForm1099ReportingCertification​(Boolean qiOptOutOfForm1099ReportingCertification)
      • qiWithholdingRatePoolCertification

        public W8ImyFormRequest qiWithholdingRatePoolCertification​(Boolean qiWithholdingRatePoolCertification)
      • getQiWithholdingRatePoolCertification

        @Nullable
        public Boolean getQiWithholdingRatePoolCertification()
        Certifies that the Qualified Intermediary meets the requirements for allocating payments to a chapter 4 withholding rate pool of U.S. payees under Regulations section 1.6049-4(c)(4)(iii).
        Returns:
        qiWithholdingRatePoolCertification
      • setQiWithholdingRatePoolCertification

        public void setQiWithholdingRatePoolCertification​(Boolean qiWithholdingRatePoolCertification)
      • qiIntermediaryOrFlowThroughEntityDocumentationCertification

        public W8ImyFormRequest qiIntermediaryOrFlowThroughEntityDocumentationCertification​(Boolean qiIntermediaryOrFlowThroughEntityDocumentationCertification)
      • getQiIntermediaryOrFlowThroughEntityDocumentationCertification

        @Nullable
        public Boolean getQiIntermediaryOrFlowThroughEntityDocumentationCertification()
        Certifies that the Qualified Intermediary has obtained or will obtain documentation confirming the status of any intermediary or flow-through entity as a participating FFI, registered deemed-compliant FFI, or QI for U.S. payees in a chapter 4 withholding rate pool.
        Returns:
        qiIntermediaryOrFlowThroughEntityDocumentationCertification
      • setQiIntermediaryOrFlowThroughEntityDocumentationCertification

        public void setQiIntermediaryOrFlowThroughEntityDocumentationCertification​(Boolean qiIntermediaryOrFlowThroughEntityDocumentationCertification)
      • qualifiedDerivativesDealerCertification

        public W8ImyFormRequest qualifiedDerivativesDealerCertification​(Boolean qualifiedDerivativesDealerCertification)
      • getQualifiedDerivativesDealerCertification

        @Nullable
        public Boolean getQualifiedDerivativesDealerCertification()
        Certifies that the Qualified Derivatives Dealer (QDD) is approved by the IRS and assumes primary withholding and reporting responsibilities for payments related to potential section 871(m) transactions.
        Returns:
        qualifiedDerivativesDealerCertification
      • setQualifiedDerivativesDealerCertification

        public void setQualifiedDerivativesDealerCertification​(Boolean qualifiedDerivativesDealerCertification)
      • getQddCorporation

        @Nullable
        public Boolean getQddCorporation()
        Indicates QDD classification is Corporation.
        Returns:
        qddCorporation
      • setQddCorporation

        public void setQddCorporation​(Boolean qddCorporation)
      • getQddPartnership

        @Nullable
        public Boolean getQddPartnership()
        Indicates QDD classification is Partnership.
        Returns:
        qddPartnership
      • setQddPartnership

        public void setQddPartnership​(Boolean qddPartnership)
      • getQddDisregardedEntity

        @Nullable
        public Boolean getQddDisregardedEntity()
        Indicates QDD classification is Disregarded Entity.
        Returns:
        qddDisregardedEntity
      • setQddDisregardedEntity

        public void setQddDisregardedEntity​(Boolean qddDisregardedEntity)
      • nonqualifiedIntermediaryCertification

        public W8ImyFormRequest nonqualifiedIntermediaryCertification​(Boolean nonqualifiedIntermediaryCertification)
      • getNonqualifiedIntermediaryCertification

        @Nullable
        public Boolean getNonqualifiedIntermediaryCertification()
        Certifies that the entity is not acting as a Qualified Intermediary and is not acting for its own account for the accounts covered by this form.
        Returns:
        nonqualifiedIntermediaryCertification
      • setNonqualifiedIntermediaryCertification

        public void setNonqualifiedIntermediaryCertification​(Boolean nonqualifiedIntermediaryCertification)
      • nqiWithholdingStatementTransmissionCertification

        public W8ImyFormRequest nqiWithholdingStatementTransmissionCertification​(Boolean nqiWithholdingStatementTransmissionCertification)
      • getNqiWithholdingStatementTransmissionCertification

        @Nullable
        public Boolean getNqiWithholdingStatementTransmissionCertification()
        Certifies that the nonqualified intermediary is submitting this form to transmit withholding certificates and/or other required documentation along with a withholding statement.
        Returns:
        nqiWithholdingStatementTransmissionCertification
      • setNqiWithholdingStatementTransmissionCertification

        public void setNqiWithholdingStatementTransmissionCertification​(Boolean nqiWithholdingStatementTransmissionCertification)
      • nqiWithholdingRatePoolComplianceCertification

        public W8ImyFormRequest nqiWithholdingRatePoolComplianceCertification​(Boolean nqiWithholdingRatePoolComplianceCertification)
      • getNqiWithholdingRatePoolComplianceCertification

        @Nullable
        public Boolean getNqiWithholdingRatePoolComplianceCertification()
        Certifies that the nonqualified intermediary meets the requirements of Regulations section 1.6049-4(c)(4)(iii) for U.S. payees included in a withholding rate pool, excluding publicly traded partnership distributions.
        Returns:
        nqiWithholdingRatePoolComplianceCertification
      • setNqiWithholdingRatePoolComplianceCertification

        public void setNqiWithholdingRatePoolComplianceCertification​(Boolean nqiWithholdingRatePoolComplianceCertification)
      • nqiQualifiedSecuritiesLenderCertification

        public W8ImyFormRequest nqiQualifiedSecuritiesLenderCertification​(Boolean nqiQualifiedSecuritiesLenderCertification)
      • getNqiQualifiedSecuritiesLenderCertification

        @Nullable
        public Boolean getNqiQualifiedSecuritiesLenderCertification()
        Certifies that the nonqualified intermediary is acting as a qualified securities lender (not as a QI) and assumes primary withholding and reporting responsibilities for U.S. source substitute dividend payments.
        Returns:
        nqiQualifiedSecuritiesLenderCertification
      • setNqiQualifiedSecuritiesLenderCertification

        public void setNqiQualifiedSecuritiesLenderCertification​(Boolean nqiQualifiedSecuritiesLenderCertification)
      • nqiAlternativeWithholdingStatementVerificationCertification

        public W8ImyFormRequest nqiAlternativeWithholdingStatementVerificationCertification​(Boolean nqiAlternativeWithholdingStatementVerificationCertification)
      • getNqiAlternativeWithholdingStatementVerificationCertification

        @Nullable
        public Boolean getNqiAlternativeWithholdingStatementVerificationCertification()
        Certifies that the nonqualified intermediary has verified, or will verify, all information on alternative withholding statements for consistency with account data to determine the correct withholding rate, as required under sections 1441 or 1471.
        Returns:
        nqiAlternativeWithholdingStatementVerificationCertification
      • setNqiAlternativeWithholdingStatementVerificationCertification

        public void setNqiAlternativeWithholdingStatementVerificationCertification​(Boolean nqiAlternativeWithholdingStatementVerificationCertification)
      • territoryFinancialInstitutionCertification

        public W8ImyFormRequest 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)
      • tfiTreatedAsUsPersonCertification

        public W8ImyFormRequest tfiTreatedAsUsPersonCertification​(Boolean tfiTreatedAsUsPersonCertification)
      • getTfiTreatedAsUsPersonCertification

        @Nullable
        public Boolean getTfiTreatedAsUsPersonCertification()
        Certifies that the territory financial institution agrees to be treated as a U.S. person for chapters 3 and 4 purposes concerning reportable amounts and withholdable payments.
        Returns:
        tfiTreatedAsUsPersonCertification
      • setTfiTreatedAsUsPersonCertification

        public void setTfiTreatedAsUsPersonCertification​(Boolean tfiTreatedAsUsPersonCertification)
      • tfiWithholdingStatementTransmissionCertification

        public W8ImyFormRequest tfiWithholdingStatementTransmissionCertification​(Boolean tfiWithholdingStatementTransmissionCertification)
      • getTfiWithholdingStatementTransmissionCertification

        @Nullable
        public Boolean getTfiWithholdingStatementTransmissionCertification()
        Certifies that the territory financial institution is transmitting withholding certificates or other required documentation and has provided or will provide a withholding statement for reportable or withholdable payments.
        Returns:
        tfiWithholdingStatementTransmissionCertification
      • setTfiWithholdingStatementTransmissionCertification

        public void setTfiWithholdingStatementTransmissionCertification​(Boolean tfiWithholdingStatementTransmissionCertification)
      • tfiTreatedAsUsPersonForPtpSalesCertification

        public W8ImyFormRequest tfiTreatedAsUsPersonForPtpSalesCertification​(Boolean tfiTreatedAsUsPersonForPtpSalesCertification)
      • getTfiTreatedAsUsPersonForPtpSalesCertification

        @Nullable
        public Boolean getTfiTreatedAsUsPersonForPtpSalesCertification()
        Certifies that the territory financial institution agrees to be treated as a U.S. person under Regulations section 1.1446(f)-4(a)(2)(i)(B) for amounts realized from sales of publicly traded partnership interests.
        Returns:
        tfiTreatedAsUsPersonForPtpSalesCertification
      • setTfiTreatedAsUsPersonForPtpSalesCertification

        public void setTfiTreatedAsUsPersonForPtpSalesCertification​(Boolean tfiTreatedAsUsPersonForPtpSalesCertification)
      • tfiNomineeUsPersonForPtpDistributionsCertification

        public W8ImyFormRequest tfiNomineeUsPersonForPtpDistributionsCertification​(Boolean tfiNomineeUsPersonForPtpDistributionsCertification)
      • getTfiNomineeUsPersonForPtpDistributionsCertification

        @Nullable
        public Boolean getTfiNomineeUsPersonForPtpDistributionsCertification()
        Certifies that the territory financial institution agrees to be treated as a U.S. person and as a nominee for purposes of publicly traded partnership distributions under the applicable regulations.
        Returns:
        tfiNomineeUsPersonForPtpDistributionsCertification
      • setTfiNomineeUsPersonForPtpDistributionsCertification

        public void setTfiNomineeUsPersonForPtpDistributionsCertification​(Boolean tfiNomineeUsPersonForPtpDistributionsCertification)
      • tfiNotNomineeForPtpDistributionsCertification

        public W8ImyFormRequest tfiNotNomineeForPtpDistributionsCertification​(Boolean tfiNotNomineeForPtpDistributionsCertification)
      • getTfiNotNomineeForPtpDistributionsCertification

        @Nullable
        public Boolean getTfiNotNomineeForPtpDistributionsCertification()
        Certifies that the territory financial institution is not acting as a nominee for publicly traded partnership distributions and is providing withholding statements for those distributions.
        Returns:
        tfiNotNomineeForPtpDistributionsCertification
      • setTfiNotNomineeForPtpDistributionsCertification

        public void setTfiNotNomineeForPtpDistributionsCertification​(Boolean tfiNotNomineeForPtpDistributionsCertification)
      • usBranchNonEffectivelyConnectedIncomeCertification

        public W8ImyFormRequest usBranchNonEffectivelyConnectedIncomeCertification​(Boolean usBranchNonEffectivelyConnectedIncomeCertification)
      • getUsBranchNonEffectivelyConnectedIncomeCertification

        @Nullable
        public Boolean getUsBranchNonEffectivelyConnectedIncomeCertification()
        Certifies that the U.S. branch is receiving reportable or withholdable payments that are not effectively connected income, PTP distributions, or proceeds from PTP sales.
        Returns:
        usBranchNonEffectivelyConnectedIncomeCertification
      • setUsBranchNonEffectivelyConnectedIncomeCertification

        public void setUsBranchNonEffectivelyConnectedIncomeCertification​(Boolean usBranchNonEffectivelyConnectedIncomeCertification)
      • usBranchAgreementToBeTreatedAsUsPersonCertification

        public W8ImyFormRequest usBranchAgreementToBeTreatedAsUsPersonCertification​(Boolean usBranchAgreementToBeTreatedAsUsPersonCertification)
      • getUsBranchAgreementToBeTreatedAsUsPersonCertification

        @Nullable
        public Boolean getUsBranchAgreementToBeTreatedAsUsPersonCertification()
        Certifies that the U.S. branch of a foreign bank or insurance company agrees to be treated as a U.S. person for reportable amounts or withholdable payments under the applicable regulations.
        Returns:
        usBranchAgreementToBeTreatedAsUsPersonCertification
      • setUsBranchAgreementToBeTreatedAsUsPersonCertification

        public void setUsBranchAgreementToBeTreatedAsUsPersonCertification​(Boolean usBranchAgreementToBeTreatedAsUsPersonCertification)
      • usBranchWithholdingStatementAndComplianceCertification

        public W8ImyFormRequest usBranchWithholdingStatementAndComplianceCertification​(Boolean usBranchWithholdingStatementAndComplianceCertification)
      • getUsBranchWithholdingStatementAndComplianceCertification

        @Nullable
        public Boolean getUsBranchWithholdingStatementAndComplianceCertification()
        Certifies that the U.S. branch is transmitting required documentation and withholding statements for reportable or withholdable payments and is applying the appropriate FATCA regulations.
        Returns:
        usBranchWithholdingStatementAndComplianceCertification
      • setUsBranchWithholdingStatementAndComplianceCertification

        public void setUsBranchWithholdingStatementAndComplianceCertification​(Boolean usBranchWithholdingStatementAndComplianceCertification)
      • usBranchActingAsUsPersonForPtpSalesCertification

        public W8ImyFormRequest usBranchActingAsUsPersonForPtpSalesCertification​(Boolean usBranchActingAsUsPersonForPtpSalesCertification)
      • getUsBranchActingAsUsPersonForPtpSalesCertification

        @Nullable
        public Boolean getUsBranchActingAsUsPersonForPtpSalesCertification()
        Certifies that the U.S. branch is acting as a U.S. person for purposes of amounts realized from sales of publicly traded partnership interests under the applicable regulations.
        Returns:
        usBranchActingAsUsPersonForPtpSalesCertification
      • setUsBranchActingAsUsPersonForPtpSalesCertification

        public void setUsBranchActingAsUsPersonForPtpSalesCertification​(Boolean usBranchActingAsUsPersonForPtpSalesCertification)
      • usBranchNomineeForPtpDistributionsCertification

        public W8ImyFormRequest usBranchNomineeForPtpDistributionsCertification​(Boolean usBranchNomineeForPtpDistributionsCertification)
      • getUsBranchNomineeForPtpDistributionsCertification

        @Nullable
        public Boolean getUsBranchNomineeForPtpDistributionsCertification()
        Certifies that the U.S. branch is treated as a U.S. person and as a nominee for publicly traded partnership distributions under the applicable regulations.
        Returns:
        usBranchNomineeForPtpDistributionsCertification
      • setUsBranchNomineeForPtpDistributionsCertification

        public void setUsBranchNomineeForPtpDistributionsCertification​(Boolean usBranchNomineeForPtpDistributionsCertification)
      • usBranchNotNomineeForPtpDistributionsCertification

        public W8ImyFormRequest usBranchNotNomineeForPtpDistributionsCertification​(Boolean usBranchNotNomineeForPtpDistributionsCertification)
      • getUsBranchNotNomineeForPtpDistributionsCertification

        @Nullable
        public Boolean getUsBranchNotNomineeForPtpDistributionsCertification()
        Certifies that the U.S. branch is not acting as a nominee for publicly traded partnership distributions and is providing the required withholding statements.
        Returns:
        usBranchNotNomineeForPtpDistributionsCertification
      • setUsBranchNotNomineeForPtpDistributionsCertification

        public void setUsBranchNotNomineeForPtpDistributionsCertification​(Boolean usBranchNotNomineeForPtpDistributionsCertification)
      • withholdingForeignPartnershipOrTrustCertification

        public W8ImyFormRequest withholdingForeignPartnershipOrTrustCertification​(Boolean withholdingForeignPartnershipOrTrustCertification)
      • getWithholdingForeignPartnershipOrTrustCertification

        @Nullable
        public Boolean getWithholdingForeignPartnershipOrTrustCertification()
        Certifies that the entity is a withholding foreign partnership (WP) or a withholding foreign trust (WT) that is compliant with the terms of its WP or WT agreement.
        Returns:
        withholdingForeignPartnershipOrTrustCertification
      • setWithholdingForeignPartnershipOrTrustCertification

        public void setWithholdingForeignPartnershipOrTrustCertification​(Boolean withholdingForeignPartnershipOrTrustCertification)
      • nonwithholdingForeignEntityWithholdingStatementCertification

        public W8ImyFormRequest nonwithholdingForeignEntityWithholdingStatementCertification​(Boolean nonwithholdingForeignEntityWithholdingStatementCertification)
      • getNonwithholdingForeignEntityWithholdingStatementCertification

        @Nullable
        public Boolean getNonwithholdingForeignEntityWithholdingStatementCertification()
        Certifies that the entity is a nonwithholding foreign partnership or trust, providing the form for non-effectively connected payments and transmitting required withholding documentation for chapters 3 and 4.
        Returns:
        nonwithholdingForeignEntityWithholdingStatementCertification
      • setNonwithholdingForeignEntityWithholdingStatementCertification

        public void setNonwithholdingForeignEntityWithholdingStatementCertification​(Boolean nonwithholdingForeignEntityWithholdingStatementCertification)
      • foreignEntityPartnerInLowerTierPartnershipCertification

        public W8ImyFormRequest foreignEntityPartnerInLowerTierPartnershipCertification​(Boolean foreignEntityPartnerInLowerTierPartnershipCertification)
      • getForeignEntityPartnerInLowerTierPartnershipCertification

        @Nullable
        public Boolean getForeignEntityPartnerInLowerTierPartnershipCertification()
        Certifies that the entity is a foreign partnership or grantor trust acting as a partner in a lower-tier partnership and is submitting the form for purposes of section 1446(a).
        Returns:
        foreignEntityPartnerInLowerTierPartnershipCertification
      • setForeignEntityPartnerInLowerTierPartnershipCertification

        public void setForeignEntityPartnerInLowerTierPartnershipCertification​(Boolean foreignEntityPartnerInLowerTierPartnershipCertification)
      • foreignPartnershipAmountRealizedSection1446FCertification

        public W8ImyFormRequest foreignPartnershipAmountRealizedSection1446FCertification​(Boolean foreignPartnershipAmountRealizedSection1446FCertification)
      • getForeignPartnershipAmountRealizedSection1446FCertification

        @Nullable
        public Boolean getForeignPartnershipAmountRealizedSection1446FCertification()
        Certifies that the entity is a foreign partnership receiving an amount realized from the transfer of a partnership interest for purposes of section 1446(f).
        Returns:
        foreignPartnershipAmountRealizedSection1446FCertification
      • setForeignPartnershipAmountRealizedSection1446FCertification

        public void setForeignPartnershipAmountRealizedSection1446FCertification​(Boolean foreignPartnershipAmountRealizedSection1446FCertification)
      • foreignPartnershipModifiedAmountRealizedCertification

        public W8ImyFormRequest foreignPartnershipModifiedAmountRealizedCertification​(Boolean foreignPartnershipModifiedAmountRealizedCertification)
      • getForeignPartnershipModifiedAmountRealizedCertification

        @Nullable
        public Boolean getForeignPartnershipModifiedAmountRealizedCertification()
        Certifies that the foreign partnership is providing a withholding statement for a modified amount realized from the transfer of a partnership interest, when applicable.
        Returns:
        foreignPartnershipModifiedAmountRealizedCertification
      • setForeignPartnershipModifiedAmountRealizedCertification

        public void setForeignPartnershipModifiedAmountRealizedCertification​(Boolean foreignPartnershipModifiedAmountRealizedCertification)
      • foreignGrantorTrustAmountRealizedAllocationCertification

        public W8ImyFormRequest foreignGrantorTrustAmountRealizedAllocationCertification​(Boolean foreignGrantorTrustAmountRealizedAllocationCertification)
      • getForeignGrantorTrustAmountRealizedAllocationCertification

        @Nullable
        public Boolean getForeignGrantorTrustAmountRealizedAllocationCertification()
        Certifies that the foreign grantor trust is submitting the form on behalf of each grantor or owner and providing a withholding statement to allocate the amount realized in accordance with the regulations.
        Returns:
        foreignGrantorTrustAmountRealizedAllocationCertification
      • setForeignGrantorTrustAmountRealizedAllocationCertification

        public void setForeignGrantorTrustAmountRealizedAllocationCertification​(Boolean foreignGrantorTrustAmountRealizedAllocationCertification)
      • alternativeWithholdingStatementRelianceCertification

        public W8ImyFormRequest alternativeWithholdingStatementRelianceCertification​(Boolean alternativeWithholdingStatementRelianceCertification)
      • getAlternativeWithholdingStatementRelianceCertification

        @Nullable
        public Boolean getAlternativeWithholdingStatementRelianceCertification()
        Certifies that the entity may rely on the information in all associated withholding certificates under the applicable standards of knowledge in sections 1441 or 1471 when providing an alternative withholding statement.
        Returns:
        alternativeWithholdingStatementRelianceCertification
      • setAlternativeWithholdingStatementRelianceCertification

        public void setAlternativeWithholdingStatementRelianceCertification​(Boolean alternativeWithholdingStatementRelianceCertification)
      • npFfiWithExemptBeneficialOwnersCertification

        public W8ImyFormRequest npFfiWithExemptBeneficialOwnersCertification​(Boolean npFfiWithExemptBeneficialOwnersCertification)
      • getNpFfiWithExemptBeneficialOwnersCertification

        @Nullable
        public Boolean getNpFfiWithExemptBeneficialOwnersCertification()
        Certifies that the nonparticipating FFI is transmitting withholding documentation and providing a statement allocating payment portions to exempt beneficial owners.
        Returns:
        npFfiWithExemptBeneficialOwnersCertification
      • setNpFfiWithExemptBeneficialOwnersCertification

        public void setNpFfiWithExemptBeneficialOwnersCertification​(Boolean npFfiWithExemptBeneficialOwnersCertification)
      • 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 W8ImyFormRequest 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 W8ImyFormRequest 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)
      • ownerDocumentedFfiCertification

        public W8ImyFormRequest 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 W8ImyFormRequest 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 W8ImyFormRequest ownerDocumentedFfiAuditorLetterCertification​(Boolean ownerDocumentedFfiAuditorLetterCertification)
      • getOwnerDocumentedFfiAuditorLetterCertification

        @Nullable
        public Boolean getOwnerDocumentedFfiAuditorLetterCertification()
        Certifies that the FFI has provided or will provide an auditor’s letter and required owner documentation, including a reporting statement and Form W-9s, to meet owner-documented FFI requirements under the regulations.
        Returns:
        ownerDocumentedFfiAuditorLetterCertification
      • setOwnerDocumentedFfiAuditorLetterCertification

        public void setOwnerDocumentedFfiAuditorLetterCertification​(Boolean ownerDocumentedFfiAuditorLetterCertification)
      • compliantNonregisteringLocalBankCertification

        public W8ImyFormRequest 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 W8ImyFormRequest 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 W8ImyFormRequest 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 W8ImyFormRequest 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 W8ImyFormRequest 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 W8ImyFormRequest 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)
      • restrictedDistributorCertification

        public W8ImyFormRequest 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 W8ImyFormRequest 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 W8ImyFormRequest 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)
      • foreignCentralBankOfIssueCertification

        public W8ImyFormRequest foreignCentralBankOfIssueCertification​(Boolean foreignCentralBankOfIssueCertification)
      • getForeignCentralBankOfIssueCertification

        @Nullable
        public Boolean getForeignCentralBankOfIssueCertification()
        Certifies that the entity is treated as the beneficial owner of the payment solely for purposes of chapter 4 under Regulations section 1.1471-6(d)(4).
        Returns:
        foreignCentralBankOfIssueCertification
      • setForeignCentralBankOfIssueCertification

        public void setForeignCentralBankOfIssueCertification​(Boolean foreignCentralBankOfIssueCertification)
      • nonreportingIgaFfiCertification

        public W8ImyFormRequest 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)
      • getIgaCountry

        @Nullable
        public String getIgaCountry()
        The country for the applicable IGA with the United States.
        Returns:
        igaCountry
      • setIgaCountry

        public void setIgaCountry​(String igaCountry)
      • getIgaModel

        @Nullable
        public String getIgaModel()
        The applicable IGA model.
        Returns:
        igaModel
      • setIgaModel

        public void setIgaModel​(String igaModel)
      • igaLegalStatusTreatment

        public W8ImyFormRequest 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)
      • getIgaFfiTrusteeOrSponsor

        @Nullable
        public String getIgaFfiTrusteeOrSponsor()
        The trustee or sponsor name for the nonreporting IGA FFI.
        Returns:
        igaFfiTrusteeOrSponsor
      • setIgaFfiTrusteeOrSponsor

        public void setIgaFfiTrusteeOrSponsor​(String igaFfiTrusteeOrSponsor)
      • getIgaFfiTrusteeIsForeign

        @Nullable
        public Boolean getIgaFfiTrusteeIsForeign()
        Indicates whether the trustee for the nonreporting IGA FFI is foreign.
        Returns:
        igaFfiTrusteeIsForeign
      • setIgaFfiTrusteeIsForeign

        public void setIgaFfiTrusteeIsForeign​(Boolean igaFfiTrusteeIsForeign)
      • treatyQualifiedPensionFundCertification

        public W8ImyFormRequest 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 W8ImyFormRequest 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 W8ImyFormRequest 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 W8ImyFormRequest 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 W8ImyFormRequest 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 W8ImyFormRequest 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)
      • exceptedNonfinancialGroupEntityCertification

        public W8ImyFormRequest 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 W8ImyFormRequest 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 W8ImyFormRequest 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 W8ImyFormRequest 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 W8ImyFormRequest 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)
      • publiclyTradedNffeCertification

        public W8ImyFormRequest 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 W8ImyFormRequest 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 W8ImyFormRequest 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)
      • 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 W8ImyFormRequest 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 W8ImyFormRequest 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)
      • 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 W8ImyFormRequest 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)
      • sponsoredDirectReportingNffeCertification

        public W8ImyFormRequest 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 W8ImyFormRequest 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)
      • getSignerName

        @Nullable
        public String getSignerName()
        The name of the signer.
        Returns:
        signerName
      • setSignerName

        public void setSignerName​(String signerName)
      • geteDeliveryConsentedAt

        @Nullable
        public OffsetDateTime geteDeliveryConsentedAt()
        The date when e-delivery was consented.
        Returns:
        eDeliveryConsentedAt
      • seteDeliveryConsentedAt

        public void seteDeliveryConsentedAt​(OffsetDateTime eDeliveryConsentedAt)
      • getSignature

        @Nullable
        public String getSignature()
        The signature of the form.
        Returns:
        signature
      • setSignature

        public void setSignature​(String signature)
      • getCompanyId

        @Nonnull
        public String getCompanyId()
        The ID of the associated company.
        Returns:
        companyId
      • setCompanyId

        public void setCompanyId​(String companyId)
      • getReferenceId

        @Nullable
        public String getReferenceId()
        A reference identifier for the form.
        Returns:
        referenceId
      • setReferenceId

        public void setReferenceId​(String referenceId)
      • getEmail

        @Nullable
        public String getEmail()
        The email address of the individual associated with the form.
        Returns:
        email
      • setEmail

        public void setEmail​(String email)
      • hashCode

        public int hashCode()
        Overrides:
        hashCode 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 W8ImyFormRequest
      • fromJson

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

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