@taxbit/react-sdk 1.1.0-beta.1 → 1.2.0-beta.0

package/README.md

@@ -4,7 +4,7 @@ A React component and hook for gathering Tax Documentation data for US and EU Ta
 
 ## Usage
 
-The Taxbit React SDK provides a React component, hook, and Typescript types for gathering tax documentation data from users. The component can be used to collect data for the Taxbit DPS (Digital Platform Sales) or W-Form (W-9, W-8BEN, W-8BEN-E) tax documentation forms. A hook provides more tools to understand the user's tax documentation status and download any pdf versions of the files that are created if eligible.
+The Taxbit React SDK provides a React component, hook, and Typescript types for gathering tax documentation data from users. The component can be used to collect data for the Taxbit DPS (Digital Platform Sales), W-Form (W-9, W-8BEN, W-8BEN-E), or Self-certification (DAC8, CARF) tax documentation forms. A hook provides additional tools to understand the user's tax documentation status and download any digital versions of the tax form files that are created if that are available.
 
 DPS (Digital Platform Sales) is a data standard and UI flow used by Taxbit to gather the information needed to report income as directed by the DAC7 for the European Union, and equivalent reporting requirements in Canada, New Zealand, and the United Kingdom.
 
@@ -179,6 +179,10 @@ type ClientTaxDocumentationStatus = {
     tinValidationDate?: string;
     needsResubmission: boolean;
   };
+  selfCertification?: {
+    dataCollectionStatus: 'COMPLETE' | 'INCOMPLETE';
+    needsResubmission: boolean;
+  };
 };
 ```
 
@@ -313,18 +317,23 @@ type Progress = {
 ```
 
 ```typescript
-type QuestionnaireType = 'DPS' | 'W-FORM';
+type QuestionnaireType = 'DPS' | 'W-FORM' | 'SELF-CERT';
 ```
 
 ## Changelog
 
+### Version 1.2.0-beta.0
+
+1. Self-Certification support
+
 ### Version 1.1.0-beta.1
 
 1. Small bug fixes related to mailing address and using enter key to submit.
+2. React 19 Support.
 
 ### Version 1.1.0-beta.0
 
-1. Treaty Claims can now be collected for the W-8BEN and W-8BEN-E forms.
+1. Treaty Claims Support on W-Forms.
 
 ### Version 1.0.0-beta.8
 
@@ -433,7 +442,7 @@ type QuestionnaireType = 'DPS' | 'W-FORM';
 
 ### Version 0.2.1
 
-1. The SDK now supports React versions 16, 17, and 18 and TypeScript versions 4 and 5.
+1. The SDK now supports React versions 16, 17, 18 and TypeScript versions 4 and 5.
 
 ### Version 0.2.0
 

package/dist/src/contexts/QuestionnaireStep/getLocal.d.ts

@@ -1,7 +1,7 @@
 import { ButtonKey, ErrorKey, PromptKey, SubPromptKey, SubTitleKey, TextKey } from '../../i18n/types';
-import { Locale, TaxDocumentation, TaxDocumentationKey } from '../../types';
+import { Locale, QuestionnaireProp, TaxDocumentation, TaxDocumentationKey } from '../../types';
 
-export declare const getLocal: (fields: TaxDocumentation, language: Locale) => {
+export declare const getLocal: (fields: TaxDocumentation, language: Locale, questionnaire: QuestionnaireProp) => {
     getLocalText: (key: TextKey) => string;
     getLocalTitle: (key: string) => string;
     getLocalSubTitle: (key: SubTitleKey) => string;
@@ -9,12 +9,13 @@ export declare const getLocal: (fields: TaxDocumentation, language: Locale) => {
     getLocalButton: (key: ButtonKey) => string;
     getLocalPrompt: (key: string) => string;
     getLocalSubPrompt: (key: TaxDocumentationKey) => string;
-    getLocalOption: (key: string | undefined) => string | undefined;
+    getLocalOption: (key: string | undefined, prefix?: string) => string | undefined;
     getLocalSubOption: (key: string | undefined) => string | undefined;
     getLocalCountry: (key: string | undefined) => string;
     getLocalUsState: (key: string | undefined) => "" | "Alabama" | "Alaska" | "Arizona" | "Arkansas" | "California" | "Colorado" | "Connecticut" | "Delaware" | "District Of Columbia" | "Florida" | "Georgia" | "Hawaii" | "Idaho" | "Illinois" | "Indiana" | "Iowa" | "Kansas" | "Kentucky" | "Louisiana" | "Maine" | "Maryland" | "Massachusetts" | "Michigan" | "Minnesota" | "Mississippi" | "Missouri" | "Montana" | "Nebraska" | "Nevada" | "New Hampshire" | "New Jersey" | "New Mexico" | "New York" | "North Carolina" | "North Dakota" | "Ohio" | "Oklahoma" | "Oregon" | "Pennsylvania" | "Rhode Island" | "South Carolina" | "South Dakota" | "Tennessee" | "Texas" | "Utah" | "Vermont" | "Virginia" | "Washington" | "West Virginia" | "Wisconsin" | "Wyoming";
     getLocalCaProvince: (key: string | undefined) => string;
     getLocalMonth: (key: string | undefined) => string;
+    getLocalAddressTitle: (data: TaxDocumentation) => string;
     getPromptKey: (key: string) => PromptKey;
     getSubPromptKey: (key: string) => SubPromptKey;
 };

package/dist/src/contexts/QuestionnaireStep/shiftControllingPerson.d.ts

@@ -0,0 +1,3 @@
+import { TaxDocumentation } from '../../types';
+
+export declare const shiftControllingPerson: (fields: TaxDocumentation, index: 1 | 2 | 3 | 4) => TaxDocumentation;

package/dist/src/contexts/QuestionnaireStep/shiftResidence.d.ts

@@ -1,3 +1,3 @@
 import { TaxDocumentation } from '../../types';
 
-export declare const shiftResidence: (fields: TaxDocumentation, index: 1 | 2 | 3 | 4) => TaxDocumentation;
+export declare const shiftResidence: (fields: TaxDocumentation, prefix: string, index: string) => TaxDocumentation;

package/dist/src/contexts/QuestionnaireStep/useQuestionnaireStep.d.ts

@@ -16,12 +16,13 @@ export declare const useQuestionnaireStep: () => {
     getLocalButton: (key: import('i18n/types').ButtonKey) => string;
     getLocalPrompt: (key: string) => string;
     getLocalSubPrompt: (key: TaxDocumentationKey) => string;
-    getLocalOption: (key: string | undefined) => string | undefined;
+    getLocalOption: (key: string | undefined, prefix?: string) => string | undefined;
     getLocalSubOption: (key: string | undefined) => string | undefined;
     getLocalCountry: (key: string | undefined) => string;
     getLocalUsState: (key: string | undefined) => "" | "Alabama" | "Alaska" | "Arizona" | "Arkansas" | "California" | "Colorado" | "Connecticut" | "Delaware" | "District Of Columbia" | "Florida" | "Georgia" | "Hawaii" | "Idaho" | "Illinois" | "Indiana" | "Iowa" | "Kansas" | "Kentucky" | "Louisiana" | "Maine" | "Maryland" | "Massachusetts" | "Michigan" | "Minnesota" | "Mississippi" | "Missouri" | "Montana" | "Nebraska" | "Nevada" | "New Hampshire" | "New Jersey" | "New Mexico" | "New York" | "North Carolina" | "North Dakota" | "Ohio" | "Oklahoma" | "Oregon" | "Pennsylvania" | "Rhode Island" | "South Carolina" | "South Dakota" | "Tennessee" | "Texas" | "Utah" | "Vermont" | "Virginia" | "Washington" | "West Virginia" | "Wisconsin" | "Wyoming";
     getLocalCaProvince: (key: string | undefined) => string;
     getLocalMonth: (key: string | undefined) => string;
+    getLocalAddressTitle: (data: TaxDocumentation) => string;
     getPromptKey: (key: string) => import('i18n/types').PromptKey;
     getSubPromptKey: (key: string) => import('i18n/types').SubPromptKey;
     clearIfNotRequired: (...arg: TaxDocumentationKey[]) => (value: Yes | undefined) => void;

package/dist/src/contexts/QuestionnaireStep/useQuestionnaireStepContext.d.ts

@@ -6,12 +6,13 @@ export declare const useQuestionnaireStepContext: () => {
     getLocalButton: (key: import('../../i18n/types/LocalizationKey.ts').ButtonKey) => string;
     getLocalPrompt: (key: string) => string;
     getLocalSubPrompt: (key: import('../../types/TaxDocumentation.ts').TaxDocumentationKey) => string;
-    getLocalOption: (key: string | undefined) => string | undefined;
+    getLocalOption: (key: string | undefined, prefix?: string) => string | undefined;
     getLocalSubOption: (key: string | undefined) => string | undefined;
     getLocalCountry: (key: string | undefined) => string;
     getLocalUsState: (key: string | undefined) => "" | "Alabama" | "Alaska" | "Arizona" | "Arkansas" | "California" | "Colorado" | "Connecticut" | "Delaware" | "District Of Columbia" | "Florida" | "Georgia" | "Hawaii" | "Idaho" | "Illinois" | "Indiana" | "Iowa" | "Kansas" | "Kentucky" | "Louisiana" | "Maine" | "Maryland" | "Massachusetts" | "Michigan" | "Minnesota" | "Mississippi" | "Missouri" | "Montana" | "Nebraska" | "Nevada" | "New Hampshire" | "New Jersey" | "New Mexico" | "New York" | "North Carolina" | "North Dakota" | "Ohio" | "Oklahoma" | "Oregon" | "Pennsylvania" | "Rhode Island" | "South Carolina" | "South Dakota" | "Tennessee" | "Texas" | "Utah" | "Vermont" | "Virginia" | "Washington" | "West Virginia" | "Wisconsin" | "Wyoming";
     getLocalCaProvince: (key: string | undefined) => string;
     getLocalMonth: (key: string | undefined) => string;
+    getLocalAddressTitle: (data: import('../../types/TaxDocumentation.ts').TaxDocumentation) => string;
     getPromptKey: (key: string) => import('../../i18n/types/LocalizationKey.ts').PromptKey;
     getSubPromptKey: (key: string) => import('../../i18n/types/LocalizationKey.ts').SubPromptKey;
     clearIfNotRequired: (...arg: import('../../types/TaxDocumentation.ts').TaxDocumentationKey[]) => (value: import('../../types/Yes.ts').Yes | undefined) => void;
@@ -37,12 +38,13 @@ export declare const useQuestionnaireStepContext: () => {
     getLocalButton: (key: import('../../i18n/types/LocalizationKey.ts').ButtonKey) => string;
     getLocalPrompt: (key: string) => string;
     getLocalSubPrompt: (key: import('../../types/TaxDocumentation.ts').TaxDocumentationKey) => string;
-    getLocalOption: (key: string | undefined) => string | undefined;
+    getLocalOption: (key: string | undefined, prefix?: string) => string | undefined;
     getLocalSubOption: (key: string | undefined) => string | undefined;
     getLocalCountry: (key: string | undefined) => string;
     getLocalUsState: (key: string | undefined) => "" | "Alabama" | "Alaska" | "Arizona" | "Arkansas" | "California" | "Colorado" | "Connecticut" | "Delaware" | "District Of Columbia" | "Florida" | "Georgia" | "Hawaii" | "Idaho" | "Illinois" | "Indiana" | "Iowa" | "Kansas" | "Kentucky" | "Louisiana" | "Maine" | "Maryland" | "Massachusetts" | "Michigan" | "Minnesota" | "Mississippi" | "Missouri" | "Montana" | "Nebraska" | "Nevada" | "New Hampshire" | "New Jersey" | "New Mexico" | "New York" | "North Carolina" | "North Dakota" | "Ohio" | "Oklahoma" | "Oregon" | "Pennsylvania" | "Rhode Island" | "South Carolina" | "South Dakota" | "Tennessee" | "Texas" | "Utah" | "Vermont" | "Virginia" | "Washington" | "West Virginia" | "Wisconsin" | "Wyoming";
     getLocalCaProvince: (key: string | undefined) => string;
     getLocalMonth: (key: string | undefined) => string;
+    getLocalAddressTitle: (data: import('../../types/TaxDocumentation.ts').TaxDocumentation) => string;
     getPromptKey: (key: string) => import('../../i18n/types/LocalizationKey.ts').PromptKey;
     getSubPromptKey: (key: string) => import('../../i18n/types/LocalizationKey.ts').SubPromptKey;
     clearIfNotRequired: (...arg: import('../../types/TaxDocumentation.ts').TaxDocumentationKey[]) => (value: import('../../types/Yes.ts').Yes | undefined) => void;

package/dist/src/contexts/TaxDocumentation/useTaxDocumentation.d.ts

@@ -1,5 +1,5 @@
 import { ClientTaxDocumentation } from '@taxbit/utilities';
-import { InputStep, Locale, Progress, Questionnaire, TaxDocumentation } from 'types';
+import { InputStep, Locale, Progress, QuestionnaireProp, TaxDocumentation } from 'types';
 import { ExternalValidations } from 'types/client';
 
 type InterviewConfig = {
@@ -12,7 +12,7 @@ export type UseTaxDocumentationProps = {
     onSubmit?: (data: ClientTaxDocumentation) => void | Promise<void>;
     onProgress?: (progress: Progress) => void | Promise<void>;
     step?: InputStep;
-    questionnaire: Questionnaire;
+    questionnaire: QuestionnaireProp;
     config?: InterviewConfig;
     treatyClaims?: boolean;
 };
@@ -25,13 +25,13 @@ export declare const useTaxDocumentation: ({ data: startingData, language: initi
     goBack: (() => void) | undefined;
     goToNext: (data: TaxDocumentation) => void;
     progress: Progress | undefined;
-    stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
+    stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "ControllingPersonDetails1" | "ControllingPersonDetails2" | "ControllingPersonDetails3" | "ControllingPersonDetails4" | "ControllingPersonDetails5" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
     data: TaxDocumentation;
     originalClientData: TaxDocumentation;
-    initialStep: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
+    initialStep: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "ControllingPersonDetails1" | "ControllingPersonDetails2" | "ControllingPersonDetails3" | "ControllingPersonDetails4" | "ControllingPersonDetails5" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
     setLanguage: (lang: Locale) => void;
     language: Locale;
-    questionnaire: Questionnaire;
+    questionnaire: QuestionnaireProp;
     externalValidations: ExternalValidations | undefined;
     config: InterviewConfig | undefined;
     isSubmitting: boolean;

package/dist/src/contexts/TaxDocumentation/useTaxDocumentationContext.d.ts

@@ -7,13 +7,13 @@ export declare const useTaxDocumentationContext: () => {
     goBack: (() => void) | undefined;
     goToNext: (data: import('../../types').TaxDocumentation) => void;
     progress: import('../..').Progress | undefined;
-    stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
+    stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "ControllingPersonDetails1" | "ControllingPersonDetails2" | "ControllingPersonDetails3" | "ControllingPersonDetails4" | "ControllingPersonDetails5" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
     data: import('../../types').TaxDocumentation;
     originalClientData: import('../../types').TaxDocumentation;
-    initialStep: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
+    initialStep: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "ControllingPersonDetails1" | "ControllingPersonDetails2" | "ControllingPersonDetails3" | "ControllingPersonDetails4" | "ControllingPersonDetails5" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
     setLanguage: (lang: import('../..').Locale) => void;
     language: import('../..').Locale;
-    questionnaire: import('../..').Questionnaire;
+    questionnaire: import('../..').QuestionnaireProp;
     externalValidations: import('../../types/client').ExternalValidations | undefined;
     config: {
         minimumAge: number;
@@ -29,13 +29,13 @@ export declare const useTaxDocumentationContext: () => {
     goBack: (() => void) | undefined;
     goToNext: (data: import('../../types').TaxDocumentation) => void;
     progress: import('../..').Progress | undefined;
-    stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
+    stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "ControllingPersonDetails1" | "ControllingPersonDetails2" | "ControllingPersonDetails3" | "ControllingPersonDetails4" | "ControllingPersonDetails5" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
     data: import('../../types').TaxDocumentation;
     originalClientData: import('../../types').TaxDocumentation;
-    initialStep: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
+    initialStep: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "ControllingPersonDetails1" | "ControllingPersonDetails2" | "ControllingPersonDetails3" | "ControllingPersonDetails4" | "ControllingPersonDetails5" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
     setLanguage: (lang: import('../..').Locale) => void;
     language: import('../..').Locale;
-    questionnaire: import('../..').Questionnaire;
+    questionnaire: import('../..').QuestionnaireProp;
     externalValidations: import('../../types/client').ExternalValidations | undefined;
     config: {
         minimumAge: number;

package/dist/src/hooks/useTaxbit/useTaxbit.d.ts

@@ -1,8 +1,8 @@
-import { Questionnaire } from 'types';
+import { QuestionnaireProp } from 'types';
 
 type UseTaxbitProps = {
     bearerToken: string;
-    questionnaire: Questionnaire;
+    questionnaire: QuestionnaireProp;
     staging?: boolean;
     onError?: (error: Error) => void | Promise<void>;
 };

package/dist/src/hooks/useTaxbit/useTaxbitStatus.d.ts

@@ -1,11 +1,11 @@
 import { SignedClientTaxDocumentation } from '@taxbit/utilities';
-import { Questionnaire } from '../../types';
+import { QuestionnaireProp } from '../../types';
 import { ClientTaxDocumentationStatus } from '../../types/client';
 
 type UseTaxbitStatusProps = {
     bearerToken?: string;
     onError?: (error: Error) => void | Promise<void>;
-    questionnaire: Questionnaire;
+    questionnaire: QuestionnaireProp;
     staging?: boolean;
 };
 export declare const useTaxbitStatus: ({ bearerToken, questionnaire, staging, onError, }: UseTaxbitStatusProps) => {

package/dist/src/i18n/locales/de.d.ts

@@ -1,4 +1,4 @@
-import { DPSPropertyFile } from '../types/PropertyFile';
+import { ForeignPropertyFile } from '../types/PropertyFile';
 
-export declare const deTranslations: DPSPropertyFile;
+export declare const deTranslations: ForeignPropertyFile;
 export declare const de: import('../types/PropertyFile').PropertyFile;

package/dist/src/i18n/locales/el.d.ts

@@ -1,4 +1,4 @@
-import { DPSPropertyFile } from '../types/PropertyFile';
+import { ForeignPropertyFile } from '../types/PropertyFile';
 
-export declare const elTranslations: DPSPropertyFile;
+export declare const elTranslations: ForeignPropertyFile;
 export declare const el: import('../types/PropertyFile').PropertyFile;

package/dist/src/i18n/locales/ga.d.ts

@@ -1,3 +1 @@
-import { PropertyFile } from '../types/PropertyFile';
-
-export declare const ga: PropertyFile;
+export declare const ga: import('../types/PropertyFile').PropertyFile;

package/dist/src/i18n/locales/lt.d.ts

@@ -1,4 +1,4 @@
-import { DPSPropertyFile } from '../types/PropertyFile';
+import { ForeignPropertyFile } from '../types/PropertyFile';
 
-export declare const ltTranslations: DPSPropertyFile;
+export declare const ltTranslations: ForeignPropertyFile;
 export declare const lt: import('../types/PropertyFile').PropertyFile;

package/dist/src/i18n/locales/pl.d.ts

@@ -1,4 +1,4 @@
-import { DPSPropertyFile } from '../types/PropertyFile';
+import { ForeignPropertyFile } from '../types/PropertyFile';
 
-export declare const plTranslations: DPSPropertyFile;
+export declare const plTranslations: ForeignPropertyFile;
 export declare const pl: import('../types/PropertyFile').PropertyFile;

package/dist/src/i18n/types/LocalizationKey.d.ts

@@ -1,11 +1,11 @@
 export type ButtonKey = 'edit' | 'back' | 'next' | 'reset' | 'submit' | 'cancel' | 'hide' | 'show';
 export type ErrorKey = 'countryMustBeAResidenceCountry' | 'formHasErrors' | 'invalid' | 'invalidDate' | 'invalidVat' | 'mustBeFiveOrNineDigits' | 'mustBeInDateFormat' | 'mustBeNineDigits' | 'mustBeNinoFormat' | 'mustBeCaPostalCodeFormat' | 'mustBeInVatinFormat' | 'mustBeValidBirthDate' | 'mustBeAtLeast18' | 'mustMatchName' | 'mustNotMatchVatin' | 'required' | 'residencesMustIncludeAddressCountry' | 'residencesMustIncludeAnEUCountry' | 'residencesMustIncludeVatCountry' | 'tooLong' | 'tooShort' | 'vatinMustNotMatchResidencyTin';
-export type SubOptionKey = 'accountHolderUsAccountType_SOLE_PROPRIETOR' | 'accountHolderUsAccountType_SM_LLC' | 'accountHolderUsAccountType_DISREGARDED_ENTITY';
-export type OptionKey = TreatyClaimOption | 'accountHolderUsPerson_yes' | 'accountHolderUsPerson_no' | 'usTrustEstateEin_yes' | 'usTrustEstateEin_no' | 'usSoleProprietorEin_yes' | 'usSoleProprietorEin_no' | 'regardedOwnerUsPerson_yes' | 'regardedOwnerUsPerson_no' | 'smllcOwnerUsPerson_yes' | 'smllcOwnerUsPerson_no' | 'smllcElection_yes' | 'smllcElection_no' | 'isIndividual_yes' | 'isIndividual_no' | 'no' | 'yes' | 'CENTRAL_BANK_OF_ISSUE' | 'COMPLEX_TRUST' | 'CORPORATION' | 'C_CORPORATION' | 'DISREGARDED_ENTITY' | 'ESTATE' | 'FOREIGN_GOVERNMENT_CONTROLLED_ENTITY' | 'FOREIGN_GOVERNMENT_INTEGRAL_PART' | 'GRANTOR_TRUST' | 'INDIVIDUAL' | 'INTERNATIONAL_ORGANIZATION' | 'LLC' | 'OTHER' | 'PARTNERSHIP' | 'PRIVATE_FOUNDATION' | 'SIMPLE_TRUST' | 'SM_LLC' | 'SOLE_PROPRIETOR' | 'S_CORPORATION' | 'TAX_EXEMPT_ORGANIZATION' | 'TRUST' | 'TRUST_ESTATE';
-export type PromptKey = TreatyClaimPrompt | 'addAdditional' | 'address' | 'businessRegistrationNumber' | 'businessRegistrationCountry' | 'city' | 'cityOfBirth' | 'country' | 'countryOfBirth' | 'dateOfBirth' | 'day' | 'dbaName' | 'exemptPayeeCode' | 'exemptFatcaCode' | 'financialAccountIdentifier' | 'financialAccountName' | 'foreignAccountType' | 'foreignOtherClassification' | 'foreignTin' | 'foreignTinIsNotRequired' | 'foreignTrustClassification' | 'isIndividual' | 'iAcknowledgeESignIsOk' | 'iAgreeWillResubmitIfIncorrect' | 'iAmACitizenOfTheUs' | 'iAmExemptFromFatcaReporting' | 'iAmNotSubjectToBackupWithholding' | 'iAuthorizeWithholdingAgent' | 'iCertifyToAll' | 'iConfirmIncomeIsNonUs' | 'iConfirmTheBeneficialOwnerIsExempt' | 'iConfirmTheInformationIsCorrectComplete' | 'iConfirmTheEntityIsNotAUsPerson' | 'iConfirmTheEntityIsTheBeneficialOwner' | 'iConfirmTheIndividualIsNotAUsPerson' | 'iConfirmTheIndividualIsTheBeneficialOwner' | 'iConfirmTheIndividualIsResidentOfTreatyCountry' | 'iConfirmTheTaxIdIsCorrect' | 'iHaveCapacityToSignForEntity' | 'iHaveCapacityToSignForIndividual' | 'mailingAddress' | 'mailingAddressIsDifferent' | 'month' | 'name' | 'nameOfDisregardedEntity' | 'nameOfEntity' | 'nameOfCCorporation' | 'nameOfCorporation' | 'nameOfIndividual' | 'nameOfIndividualSoleProprietor' | 'nameOfLlc' | 'nameOfOrganization' | 'nameOfPartnership' | 'nameOfSCorporation' | 'nameOfSmllc' | 'nameOfSmllcOwner' | 'nameOfSoleProprietor' | 'nameOfTrustEstate' | 'nameOfTrust' | 'province' | 'referenceNumbers' | 'regardedOwnerUsPerson' | 'regardedOwnerAccountType' | 'removeResidence' | 'signature' | 'smllcElection' | 'smllcOwnerAccountType' | 'smllcOwnerUsPerson' | 'state' | 'stateProvince' | 'street' | 'street2' | 'taxIdNumber' | 'taxIdNumberIsNotRequired' | 'tin' | 'tinUkCrn' | 'tinUkNino' | 'usAccountType' | 'usLlcClassification' | 'usOtherClassification' | 'usPerson' | 'usEin' | 'usSoleProprietorEin' | 'usSsn' | 'usTin' | 'usTrustEstateEin' | 'vatIdentificationNumber' | 'vatIsNotRequired' | 'vatCountry' | 'year' | 'zip';
-export type SubPromptKey = TreatyClaimSubPrompt | 'smllcElection' | 'iAmNotSubjectToBackupWithholding' | 'iConfirmIncomeIsNonUs' | 'isIndividual' | 'financialAccountIdentifier' | 'financialAccountName' | 'vatIdentificationNumber' | 'placeOfBirth' | 'referenceNumbers' | 'signature' | 'streetIsPermanent' | 'usPerson';
-export type TitleKey = 'accountHolder' | 'accountHolderClassification' | 'accountHolderContactInformation' | 'accountHolderTaxInformation' | 'accountHolderTaxClarification' | 'accountHolderTreatyClaims' | 'address' | 'additionalConditions' | 'acknowledge' | 'certify' | 'confirmation' | 'countryOfCitizenship' | 'countryOfIncorporation' | 'exemptions' | 'mailingAddress' | 'primaryAddress' | 'permanentAddress' | 'placeOfBirth' | 'regardedOwner' | 'regardedOwnerClassification' | 'regardedOwnerContactInformation' | 'regardedOwnerTaxInformation' | 'regardedOwnerTreatyClaims' | 'signature' | 'summary' | 'taxResidences' | 'taxResidence1' | 'taxResidence2' | 'taxResidence3' | 'taxResidence4' | 'taxResidence5' | 'w8imyInstructions';
-export type SubTitleKey = 'taxResidences' | 'permanentAddress' | 'taxInformationTreatyClaims';
+export type SubOptionKey = 'accountHolderUsAccountType_SOLE_PROPRIETOR' | 'accountHolderUsAccountType_SM_LLC' | 'accountHolderUsAccountType_DISREGARDED_ENTITY' | 'accountHolderActiveNonFinancialEntityType_OTHER' | 'accountHolderActiveNonFinancialEntityType_PUBLIC_CORPORATION';
+export type OptionKey = TreatyClaimOption | 'accountHolderUsPerson_yes' | 'accountHolderUsPerson_no' | 'usTrustEstateEin_yes' | 'usTrustEstateEin_no' | 'usSoleProprietorEin_yes' | 'usSoleProprietorEin_no' | 'regardedOwnerUsPerson_yes' | 'regardedOwnerUsPerson_no' | 'smllcOwnerUsPerson_yes' | 'smllcOwnerUsPerson_no' | 'smllcElection_yes' | 'smllcElection_no' | 'isIndividual_yes' | 'isIndividual_no' | 'isInvestmentEntityManaged_yes' | 'isInvestmentEntityManaged_no' | 'no' | 'yes' | 'ACTIVE_NON_FINANCIAL_ENTITY' | 'CENTRAL_BANK_OF_ISSUE' | 'COMPLEX_TRUST' | 'CORPORATION' | 'CUSTODIAL_INSTITUTION' | 'C_CORPORATION' | 'DEPOSITORY_INSTITUTION' | 'DISREGARDED_ENTITY' | 'ENTITY_TYPE_TRUST' | 'ENTITY_TYPE_SIMILAR_TO_TRUST' | 'ENTITY_TYPE_OTHER' | 'ESTATE' | 'FINANCIAL_INSTITUTION' | 'FOREIGN_GOVERNMENT_CONTROLLED_ENTITY' | 'FOREIGN_GOVERNMENT_INTEGRAL_PART' | 'accountHolderActiveNonFinancialEntityType_GOVERNMENT_ENTITY' | 'GRANTOR_TRUST' | 'INDIVIDUAL' | 'accountHolderActiveNonFinancialEntityType_INTERNATIONAL_ORGANIZATION' | 'INTERNATIONAL_ORGANIZATION' | 'INVESTMENT_ENTITY' | 'INSURANCE_COMPANY' | 'LLC' | 'OTHER' | 'accountHolderActiveNonFinancialEntityType_OTHER' | 'PARTNERSHIP' | 'PASSIVE_NON_FINANCIAL_ENTITY' | 'PRIVATE_FOUNDATION' | 'accountHolderActiveNonFinancialEntityType_PUBLIC_CORPORATION' | 'SIGNATURE_CAPACITY_EXECUTOR' | 'SIGNATURE_CAPACITY_OFFICER' | 'SIGNATURE_CAPACITY_OTHER_CAPACITY' | 'SIMPLE_TRUST' | 'SM_LLC' | 'SOLE_PROPRIETOR' | 'S_CORPORATION' | 'TAX_EXEMPT_ORGANIZATION' | 'TRUST' | 'TRUST_ESTATE' | 'CONTROLLING_PERSON_ROLE_SETTLOR' | 'CONTROLLING_PERSON_ROLE_TRUSTEE' | 'CONTROLLING_PERSON_ROLE_PROTECTOR' | 'CONTROLLING_PERSON_ROLE_BENEFICIARY' | 'CONTROLLING_PERSON_ROLE_OTHER' | 'CONTROLLING_PERSON_ROLE_SETTLOR_EQUIVALENT' | 'CONTROLLING_PERSON_ROLE_TRUSTEE_EQUIVALENT' | 'CONTROLLING_PERSON_ROLE_PROTECTOR_EQUIVALENT' | 'CONTROLLING_PERSON_ROLE_BENEFICIARY_EQUIVALENT' | 'CONTROLLING_PERSON_ROLE_OTHER_EQUIVALENT' | 'CONTROLLING_PERSON_ROLE_OWNER' | 'CONTROLLING_PERSON_ROLE_OTHER_MEANS' | 'CONTROLLING_PERSON_ROLE_SENIOR_MANAGING_OFFICIAL' | 'MISSING_TIN_NOT_REQUIRED_REASON_NOT_ISSUED' | 'MISSING_TIN_NOT_REQUIRED_REASON_NOT_REQUIRED' | 'MISSING_TIN_NOT_REQUIRED_REASON_OTHER';
+export type PromptKey = TreatyClaimPrompt | 'activeNonFinancialEntityType' | 'addAdditionalResidence' | 'addControllingPerson' | 'address' | 'businessRegistrationNumber' | 'businessRegistrationCountry' | 'city' | 'cityOfBirth' | 'country' | 'countryOfBirth' | 'dateOfBirth' | 'day' | 'dbaName' | 'exemptPayeeCode' | 'exemptFatcaCode' | 'financialAccountIdentifier' | 'financialAccountName' | 'foreignAccountType' | 'financialInstitutionType' | 'foreignOtherClassification' | 'foreignTin' | 'foreignTinIsNotRequired' | 'foreignTrustClassification' | 'investmentEntityManaged' | 'isIndividual' | 'iAcknowledgeESignIsOk' | 'iWillResubmitIfIncorrect' | 'iAmACitizenOfTheUs' | 'iAmExemptFromFatcaReporting' | 'iAmNotSubjectToBackupWithholding' | 'iAuthorizeWithholdingAgent' | 'iCertifyToAll' | 'iConfirmIncomeIsNonUs' | 'iConfirmTheBeneficialOwnerIsExempt' | 'iConfirmTheInformationIsCorrectComplete' | 'iConfirmTheEntityIsNotAUsPerson' | 'iConfirmTheEntityIsTheBeneficialOwner' | 'iConfirmTheIndividualIsNotAUsPerson' | 'iConfirmTheIndividualIsTheBeneficialOwner' | 'iConfirmTheIndividualIsResidentOfTreatyCountry' | 'iConfirmTheTaxIdIsCorrect' | 'iHaveCapacityToSignForEntity' | 'iHaveCapacityToSignForIndividual' | 'iDeclareStatementsAreCorrect' | 'iUnderstandTheInformationIsCovered' | 'iAcknowledgeTheInformationMayBeProvided' | 'iCertifyIAmAccountHolder' | 'iCertifyIAmAuthorizedToSignForAccountHolder' | 'iCertifyIWillNotifyPersons' | 'iWillNotifyChangeInCircumstanceForIndividual' | 'iWillNotifyChangeInCircumstanceForAccountHolder' | 'mailingAddress' | 'mailingAddressIsDifferent' | 'month' | 'name' | 'nameOfDisregardedEntity' | 'nameOfEntity' | 'nameOfCCorporation' | 'nameOfCorporation' | 'nameOfIndividual' | 'nameOfIndividualSoleProprietor' | 'nameOfLlc' | 'nameOfOrganization' | 'nameOfPartnership' | 'nameOfSCorporation' | 'nameOfSmllc' | 'nameOfSmllcOwner' | 'nameOfSoleProprietor' | 'nameOfTrustEstate' | 'nameOfTrust' | 'otherRole' | 'otherEquivalentRole' | 'ownershipPercentage' | 'managedEntityType' | 'passiveEntityType' | 'province' | 'referenceNumbers' | 'regardedOwnerUsPerson' | 'regardedOwnerAccountType' | 'relatedCorporation' | 'removeResidence' | 'removeControllingPerson' | 'role' | 'securitiesMarket' | 'signature' | 'signatureCapacity' | 'signatureCapacityOther' | 'smllcElection' | 'smllcOwnerAccountType' | 'smllcOwnerUsPerson' | 'countyRegion' | 'stateProvince' | 'street' | 'street2' | 'taxIdNumber' | 'taxIdNumberIsNotRequired' | 'taxIdNumberIsNotRequiredReason' | 'taxIdNumberIsNotRequiredReasonOther' | 'tin' | 'tinUkCrn' | 'tinUkNino' | 'type' | 'usAccountType' | 'usLlcClassification' | 'usOtherClassification' | 'usPerson' | 'usEin' | 'usSoleProprietorEin' | 'usSsn' | 'usTin' | 'usTrustEstateEin' | 'vatIdentificationNumber' | 'vatIsNotRequired' | 'vatCountry' | 'year' | 'zip';
+export type SubPromptKey = TreatyClaimSubPrompt | 'smllcElection' | 'iAmNotSubjectToBackupWithholding' | 'iConfirmIncomeIsNonUs' | 'isIndividual' | 'financialAccountIdentifier' | 'financialAccountName' | 'financialInstitutionType' | 'vatIdentificationNumber' | 'placeOfBirth' | 'referenceNumbers' | 'relatedCorporation' | 'role' | 'securitiesMarket' | 'signature' | 'signatureCapacityOther' | 'streetIsPermanent' | 'usPerson';
+export type TitleKey = 'accountHolder' | 'accountHolderClassification' | 'accountHolderContactInformation' | 'accountHolderTaxInformation' | 'accountHolderTaxClarification' | 'accountHolderTreatyClaims' | 'address' | 'additionalConditions' | 'acknowledge' | 'carfClassificationDetails' | 'certify' | 'confirmation' | 'controllingPersonDetails' | 'controllingPersons' | 'controllingPerson1' | 'controllingPerson2' | 'controllingPerson3' | 'controllingPerson4' | 'controllingPerson5' | 'countryOfCitizenship' | 'countryOfIncorporation' | 'exemptions' | 'mailingAddress' | 'primaryAddress' | 'permanentAddress' | 'placeOfBirth' | 'regardedOwner' | 'regardedOwnerClassification' | 'regardedOwnerContactInformation' | 'regardedOwnerTaxInformation' | 'regardedOwnerTreatyClaims' | 'signature' | 'summary' | 'taxResidences' | 'taxResidence1' | 'taxResidence2' | 'taxResidence3' | 'taxResidence4' | 'taxResidence5' | 'w8imyInstructions';
+export type SubTitleKey = 'controllingPersonDetails' | 'taxResidences' | 'permanentAddress' | 'taxInformationTreatyClaims';
 export type TextKey = 'eSignActReference' | 'notRequired' | 'notRequiredOrNotIssued' | 'interviewIsComplete' | 'penaltyOfPerjury' | 'penaltiesOfPerjury' | 'retrievingInterviewStatus' | 'taxDocumentationSaved' | 'w8imyInstructions';
 type TreatyClaimPrompt = 'treatyClaimIsEligible' | 'treatyClaimICertifyResident' | 'treatyClaimICertifyRequirements' | 'treatyClaimCountry' | 'treatyClaimTypeOfIncome' | 'treatyClaimWithholding' | 'treatyClaimAdditionalConditions' | 'treatyClaimLimitationOnBenefits' | 'treatyClaimLimitationOnBenefitsOtherArticleParagraph';
 type TreatyClaimSubPrompt = 'treatyClaimIsEligible' | 'treatyClaimWithholding' | 'treatyClaimAdditionalConditions' | 'treatyClaimLimitationOnBenefits';

package/dist/src/i18n/types/PropertyFile.d.ts

@@ -29,23 +29,24 @@ export type PropertyFile = {
         [key in TextKey]: string;
     };
 };
-export type DPSPropertyFile = {
+export type ForeignPropertyFile = {
     button: PropertyFile['button'];
-    prompt: Pick<PropertyFile['prompt'], 'addAdditional' | 'address' | 'businessRegistrationCountry' | 'businessRegistrationNumber' | 'city' | 'cityOfBirth' | 'country' | 'countryOfBirth' | 'dateOfBirth' | 'day' | 'financialAccountIdentifier' | 'financialAccountName' | 'iConfirmTheInformationIsCorrectComplete' | 'isIndividual' | 'month' | 'name' | 'nameOfEntity' | 'nameOfIndividual' | 'province' | 'removeResidence' | 'state' | 'stateProvince' | 'street' | 'street2' | 'taxIdNumber' | 'taxIdNumberIsNotRequired' | 'tin' | 'tinUkCrn' | 'tinUkNino' | 'usTin' | 'vatCountry' | 'vatIdentificationNumber' | 'vatIsNotRequired' | 'year' | 'zip'>;
-    subPrompt: Pick<PropertyFile['subPrompt'], 'financialAccountIdentifier' | 'financialAccountName' | 'isIndividual' | 'placeOfBirth' | 'streetIsPermanent' | 'vatIdentificationNumber'>;
-    subTitle: Pick<PropertyFile['subTitle'], 'taxResidences'>;
-    title: Pick<PropertyFile['title'], 'accountHolder' | 'accountHolderClassification' | 'accountHolderContactInformation' | 'accountHolderTaxInformation' | 'accountHolderTaxClarification' | 'address' | 'confirmation' | 'countryOfCitizenship' | 'countryOfIncorporation' | 'permanentAddress' | 'placeOfBirth' | 'summary' | 'taxResidences' | 'taxResidence1' | 'taxResidence2' | 'taxResidence3' | 'taxResidence4' | 'taxResidence5'>;
+    prompt: Pick<PropertyFile['prompt'], 'addAdditionalResidence' | 'addControllingPerson' | 'financialInstitutionType' | 'activeNonFinancialEntityType' | 'passiveEntityType' | 'managedEntityType' | 'investmentEntityManaged' | 'iUnderstandTheInformationIsCovered' | 'iAcknowledgeTheInformationMayBeProvided' | 'iCertifyIAmAccountHolder' | 'iCertifyIAmAuthorizedToSignForAccountHolder' | 'iCertifyIWillNotifyPersons' | 'iDeclareStatementsAreCorrect' | 'iWillNotifyChangeInCircumstanceForIndividual' | 'iWillNotifyChangeInCircumstanceForAccountHolder' | 'otherRole' | 'otherEquivalentRole' | 'ownershipPercentage' | 'relatedCorporation' | 'removeControllingPerson' | 'role' | 'securitiesMarket' | 'taxIdNumberIsNotRequiredReason' | 'taxIdNumberIsNotRequiredReasonOther' | 'address' | 'businessRegistrationCountry' | 'businessRegistrationNumber' | 'city' | 'cityOfBirth' | 'country' | 'countryOfBirth' | 'dateOfBirth' | 'day' | 'financialAccountIdentifier' | 'financialAccountName' | 'iConfirmTheInformationIsCorrectComplete' | 'isIndividual' | 'month' | 'name' | 'nameOfEntity' | 'nameOfIndividual' | 'province' | 'removeResidence' | 'countyRegion' | 'stateProvince' | 'street' | 'street2' | 'signatureCapacity' | 'signatureCapacityOther' | 'taxIdNumber' | 'taxIdNumberIsNotRequired' | 'tin' | 'tinUkCrn' | 'tinUkNino' | 'type' | 'usTin' | 'vatCountry' | 'vatIdentificationNumber' | 'vatIsNotRequired' | 'year' | 'zip'>;
+    subPrompt: Pick<PropertyFile['subPrompt'], 'financialAccountIdentifier' | 'financialAccountName' | 'financialInstitutionType' | 'isIndividual' | 'placeOfBirth' | 'relatedCorporation' | 'role' | 'securitiesMarket' | 'signatureCapacityOther' | 'streetIsPermanent' | 'vatIdentificationNumber'>;
+    subTitle: Pick<PropertyFile['subTitle'], 'taxResidences' | 'controllingPersonDetails'>;
+    title: Pick<PropertyFile['title'], 'carfClassificationDetails' | 'controllingPersonDetails' | 'controllingPersons' | 'controllingPerson1' | 'controllingPerson2' | 'controllingPerson3' | 'controllingPerson4' | 'controllingPerson5' | 'accountHolder' | 'accountHolderClassification' | 'accountHolderContactInformation' | 'accountHolderTaxInformation' | 'accountHolderTaxClarification' | 'address' | 'confirmation' | 'countryOfCitizenship' | 'countryOfIncorporation' | 'permanentAddress' | 'placeOfBirth' | 'summary' | 'taxResidences' | 'taxResidence1' | 'taxResidence2' | 'taxResidence3' | 'taxResidence4' | 'taxResidence5'>;
     text: Pick<PropertyFile['text'], 'interviewIsComplete' | 'notRequired' | 'notRequiredOrNotIssued' | 'retrievingInterviewStatus' | 'taxDocumentationSaved'>;
     error: Pick<PropertyFile['error'], 'countryMustBeAResidenceCountry' | 'formHasErrors' | 'invalid' | 'invalidDate' | 'invalidVat' | 'mustBeAtLeast18' | 'mustBeFiveOrNineDigits' | 'mustBeInDateFormat' | 'mustBeInVatinFormat' | 'mustBeNineDigits' | 'mustBeNinoFormat' | 'mustBeCaPostalCodeFormat' | 'mustBeValidBirthDate' | 'mustNotMatchVatin' | 'required' | 'residencesMustIncludeAddressCountry' | 'residencesMustIncludeAnEUCountry' | 'residencesMustIncludeVatCountry' | 'tooLong' | 'tooShort' | 'vatinMustNotMatchResidencyTin'>;
-    option: Pick<PropertyFile['option'], 'no' | 'yes' | 'isIndividual_yes' | 'isIndividual_no'>;
+    option: Pick<PropertyFile['option'], 'no' | 'yes' | 'isIndividual_yes' | 'isIndividual_no' | 'isInvestmentEntityManaged_yes' | 'isInvestmentEntityManaged_no' | 'ACTIVE_NON_FINANCIAL_ENTITY' | 'PASSIVE_NON_FINANCIAL_ENTITY' | 'CUSTODIAL_INSTITUTION' | 'accountHolderActiveNonFinancialEntityType_GOVERNMENT_ENTITY' | 'INSURANCE_COMPANY' | 'INVESTMENT_ENTITY' | 'ENTITY_TYPE_TRUST' | 'ENTITY_TYPE_SIMILAR_TO_TRUST' | 'ENTITY_TYPE_OTHER' | 'accountHolderActiveNonFinancialEntityType_PUBLIC_CORPORATION' | 'accountHolderActiveNonFinancialEntityType_OTHER' | 'accountHolderActiveNonFinancialEntityType_INTERNATIONAL_ORGANIZATION' | 'SIGNATURE_CAPACITY_EXECUTOR' | 'SIGNATURE_CAPACITY_OFFICER' | 'SIGNATURE_CAPACITY_OTHER_CAPACITY' | 'DEPOSITORY_INSTITUTION' | 'FINANCIAL_INSTITUTION' | 'CONTROLLING_PERSON_ROLE_SETTLOR' | 'CONTROLLING_PERSON_ROLE_TRUSTEE' | 'CONTROLLING_PERSON_ROLE_PROTECTOR' | 'CONTROLLING_PERSON_ROLE_BENEFICIARY' | 'CONTROLLING_PERSON_ROLE_OTHER' | 'CONTROLLING_PERSON_ROLE_SETTLOR_EQUIVALENT' | 'CONTROLLING_PERSON_ROLE_TRUSTEE_EQUIVALENT' | 'CONTROLLING_PERSON_ROLE_PROTECTOR_EQUIVALENT' | 'CONTROLLING_PERSON_ROLE_BENEFICIARY_EQUIVALENT' | 'CONTROLLING_PERSON_ROLE_OTHER_EQUIVALENT' | 'CONTROLLING_PERSON_ROLE_OWNER' | 'CONTROLLING_PERSON_ROLE_OTHER_MEANS' | 'CONTROLLING_PERSON_ROLE_SENIOR_MANAGING_OFFICIAL' | 'MISSING_TIN_NOT_REQUIRED_REASON_NOT_ISSUED' | 'MISSING_TIN_NOT_REQUIRED_REASON_NOT_REQUIRED' | 'MISSING_TIN_NOT_REQUIRED_REASON_OTHER'>;
+    subOption: Pick<PropertyFile['subOption'], 'accountHolderActiveNonFinancialEntityType_PUBLIC_CORPORATION' | 'accountHolderActiveNonFinancialEntityType_OTHER'>;
 };
 export type PartialDPSPropertyFile = {
-    button?: Partial<DPSPropertyFile['button']>;
-    prompt?: Partial<DPSPropertyFile['prompt']>;
-    subPrompt?: Partial<DPSPropertyFile['subPrompt']>;
-    subTitle?: Partial<DPSPropertyFile['subTitle']>;
-    title?: Partial<DPSPropertyFile['title']>;
-    text?: Partial<DPSPropertyFile['text']>;
-    error?: Partial<DPSPropertyFile['error']>;
-    option?: Partial<DPSPropertyFile['option']>;
+    button?: Partial<ForeignPropertyFile['button']>;
+    prompt?: Partial<ForeignPropertyFile['prompt']>;
+    subPrompt?: Partial<ForeignPropertyFile['subPrompt']>;
+    subTitle?: Partial<ForeignPropertyFile['subTitle']>;
+    title?: Partial<ForeignPropertyFile['title']>;
+    text?: Partial<ForeignPropertyFile['text']>;
+    error?: Partial<ForeignPropertyFile['error']>;
+    option?: Partial<ForeignPropertyFile['option']>;
 };

package/dist/src/index.d.ts

@@ -1,9 +1,9 @@
 import { ClientTaxDocumentation } from '@taxbit/utilities';
 
-export * from './entry/TaxbitQuestionnaire';
 export * from './hooks/useTaxbit/useTaxbit';
 export * from './types/client/ClientTaxDocumentationStatus';
 export * from './types/Locale';
 export * from './types/Progress';
-export * from './types/Questionnaire';
+export * from './types/QuestionnaireProp.ts';
+export * from './widgets/TaxbitQuestionnaire';
 export type { ClientTaxDocumentation };

package/dist/src/lookups/activeNonFinancialEntityTypeOptions.d.ts

@@ -0,0 +1,3 @@
+export declare const activeNonFinancialEntityTypeOptions: {
+    value: T;
+}[];

package/dist/src/lookups/controllingPersonRoleOptions.d.ts

@@ -0,0 +1,3 @@
+export declare const getControllingPersonRoleOptions: (entityType: string | undefined) => {
+    value: T;
+}[];

package/dist/src/lookups/entityTypeOptions.d.ts

@@ -0,0 +1,3 @@
+export declare const entityTypeOptions: {
+    value: T;
+}[];

package/dist/src/lookups/financialInstitutionTypeOptions.d.ts

@@ -0,0 +1,3 @@
+export declare const financialInstitutionTypeOptions: {
+    value: T;
+}[];

package/dist/src/lookups/index.d.ts

@@ -1,6 +1,10 @@
+export * from './activeNonFinancialEntityTypeOptions';
+export * from './controllingPersonRoleOptions';
 export * from './countryOptions';
 export * from './dayOptions';
+export * from './entityTypeOptions.ts';
 export * from './fatcaCodeOptions';
+export * from './financialInstitutionTypeOptions';
 export * from './foreignAccountHolderAccountTypeOptions';
 export * from './foreignOtherClassificationOptions';
 export * from './foreignRegardedOwnerAccountTypeOptions';
@@ -8,6 +12,9 @@ export * from './foreignTrustClassificationOptions';
 export * from './getTreatyCountryLimitationOnBenefitOptions';
 export * from './localeOptions';
 export * from './payeeCodeOptions';
+export * from './selfCertificationAccountTypeOptions';
+export * from './signatureCapacityOptions';
+export * from './tinNotRequiredReasonOptions';
 export * from './typeOfIncomeOptions';
 export * from './usAccountHolderAccountTypeOptions';
 export * from './usLlcAccountTypeOptions';

package/dist/src/lookups/payeeCodeOptions.d.ts

@@ -1,4 +1,4 @@
 export declare const payeeCodeOptions: {
-    label: "10" | "11" | "12" | "13" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9";
+    label: "1" | "2" | "3" | "4" | "5" | "10" | "11" | "12" | "13" | "6" | "7" | "8" | "9";
     value: T;
 }[];

package/dist/src/lookups/selfCertificationAccountTypeOptions.d.ts

@@ -0,0 +1,3 @@
+export declare const selfCertificationAccountTypeOptions: {
+    value: T;
+}[];

package/dist/src/lookups/signatureCapacityOptions.d.ts

@@ -0,0 +1,3 @@
+export declare const signatureCapacityOptions: {
+    value: T;
+}[];

package/dist/src/lookups/tinNotRequiredReasonOptions.d.ts

@@ -0,0 +1,3 @@
+export declare const tinNotRequiredReasonOptions: {
+    value: T;
+}[];

package/dist/src/services/api.d.ts

@@ -1,9 +1,12 @@
-import { Questionnaire } from 'types';
+import { QuestionnaireProp } from 'types';
 
+export declare const TAX_DOCUMENTATION_SUBMISSIONS_PATH = "tax-documentation/submissions";
+export declare const TAX_DOCUMENTATION_STATUS_PATH = "tax-documentation-status";
+export declare const TAX_DOCUMENT_PATH = "tax-documentation/document";
 export declare const api: {
     taxDocumentationSubmissions: {
         post: (environment: "PRODUCTION" | "STAGING") => string;
-        get: (environment: "PRODUCTION" | "STAGING", questionnaire: Questionnaire) => string;
+        get: (environment: "PRODUCTION" | "STAGING", questionnaire: QuestionnaireProp) => string;
     };
     taxDocumentationStatus: {
         get: (environment: "PRODUCTION" | "STAGING") => string;

package/dist/src/services/msw.d.ts

@@ -0,0 +1,33 @@
+type ResponseOptions = {
+    once?: boolean;
+    body?: unknown;
+    status?: number;
+};
+export declare const mockApi: {
+    taxDocumentationSubmissions: {
+        get: {
+            success: (options?: ResponseOptions) => import('msw').HttpHandler;
+        };
+        post: {
+            success: (options?: ResponseOptions) => import('msw').HttpHandler;
+            unauthorized: (options?: ResponseOptions) => import('msw').HttpHandler;
+        };
+    };
+    taxDocumentationStatus: {
+        get: {
+            success: (options?: ResponseOptions) => import('msw').HttpHandler;
+            unauthorized: (options?: ResponseOptions) => import('msw').HttpHandler;
+        };
+    };
+    taxDocument: {
+        post: {
+            success: (options?: ResponseOptions) => import('msw').HttpHandler;
+        };
+        get: {
+            success: (options?: ResponseOptions) => import('msw').HttpHandler;
+            pending: (options?: ResponseOptions) => import('msw').HttpHandler;
+        };
+    };
+};
+export declare const successHandlers: import('msw').HttpHandler[];
+export {};

package/dist/src/test/Wrapper.d.ts

@@ -1,8 +1,8 @@
 import { ClientTaxDocumentation } from '@taxbit/utilities';
 import { default as React } from 'react';
-import { Questionnaire } from '../types';
+import { QuestionnaireProp } from '../types';
 
 export declare const Wrapper: React.FC<React.PropsWithChildren & {
     initialData?: ClientTaxDocumentation;
-    questionnaire?: Questionnaire;
+    questionnaire?: QuestionnaireProp;
 }>;

package/dist/src/test/getWrapper.d.ts

@@ -1,5 +1,5 @@
 import { ClientTaxDocumentation } from '@taxbit/utilities';
 import { default as React } from 'react';
-import { Questionnaire } from '../types';
+import { QuestionnaireProp } from '../types';
 
-export declare const getWrapper: (initialData?: ClientTaxDocumentation, questionnaire?: Questionnaire) => ({ children }: React.PropsWithChildren) => React.ReactNode | Promise<React.ReactNode>;
+export declare const getWrapper: (initialData?: ClientTaxDocumentation, questionnaire?: QuestionnaireProp) => ({ children }: React.PropsWithChildren) => React.ReactNode | Promise<React.ReactNode>;

package/dist/src/test/utils/helpers.d.ts

@@ -1,9 +1,16 @@
 export declare const expectRowError: (prompt: string) => void;
 export declare const expectRowErrorText: (prompt: string, text: string) => void;
 export declare const expectNoRowError: (prompt: string) => void;
+export declare const expectQuestionCount: (count: number) => void;
 export declare const expectText: (text: string, length?: number) => void;
 export declare const expectSummaryFieldText: (field: string, text: string) => void;
 export declare const expectNullInput: (ariaLabel: string) => void;
+export declare const expectVisibleQuestion: (prompt: string) => void;
+export declare const expectNoQuestion: (prompt: string) => void;
+export declare const expectCheckbox: (prompt: string) => void;
+export declare const expectNoCheckbox: (prompt: string) => void;
+export declare const expectSection: (title: string) => void;
+export declare const expectNoSection: (title: string) => void;
 export declare const expectDisabledInput: (ariaLabel: string) => void;
 export declare const expectInputValue: (ariaLabel: string, value: string) => void;
 export declare const clickLabel: (ariaLabel: string) => void;
@@ -16,8 +23,11 @@ export declare const clickNext: () => void;
 export declare const clickSubmit: () => void;
 export declare const clickAddAdditionalResidence: () => void;
 export declare const clickRemoveResidence: (index: 1 | 2 | 3 | 4 | 5) => void;
+export declare const clickAddControllingPerson: () => void;
+export declare const clickRemoveControllingPerson: (index: 1 | 2 | 3 | 4 | 5) => void;
 export declare const setBusinessNameAndAddress: (prefix?: string) => void;
 export declare const setIndividualNameAndAddress: (prefix?: string) => void;
 export declare const setUSIndividualNameAndAddress: (prefix?: string) => void;
 export declare const setIndividualNameAndAddressAndBirthDate: (prefix?: string) => void;
 export declare const setUSIndividualNameAndAddressAndBirthDate: (prefix?: string) => void;
+export declare const setIndividualCountryNameAndAddressAndBirthDate: (prefix?: string) => void;

package/dist/src/types/InputStep.d.ts

@@ -1,4 +1,4 @@
-declare const inputSteps: readonly ["AccountHolderClassification", "AccountHolderContact", "AccountHolderTax", "AccountHolderTaxClarification", "AccountHolderTreatyClaims", "Exemptions", "RegardedOwnerContact", "RegardedOwnerTax", "RegardedOwnerTreatyClaims", "Summary", "W8imyInstructions"];
+declare const inputSteps: readonly ["AccountHolderClassification", "AccountHolderContact", "AccountHolderTax", "AccountHolderTaxClarification", "AccountHolderTreatyClaims", "ControllingPersonDetails1", "ControllingPersonDetails2", "ControllingPersonDetails3", "ControllingPersonDetails4", "ControllingPersonDetails5", "Exemptions", "RegardedOwnerContact", "RegardedOwnerTax", "RegardedOwnerTreatyClaims", "Summary", "W8imyInstructions"];
 export type InputStep = (typeof inputSteps)[number];
 export declare const isInputStep: (step: string) => step is InputStep;
 export declare const confirmInputStep: (step: string) => InputStep;

package/dist/src/types/QuestionnaireProp.d.ts

@@ -0,0 +1 @@
+export type QuestionnaireProp = 'W-FORM' | 'DPS' | 'SELF-CERT';

package/dist/src/types/StepId.d.ts

@@ -1 +1 @@
-export type StepId = 'accountHolderContactInformation' | 'accountHolderTaxInformation' | 'accountHolderClassification' | 'accountHolderTaxClarification' | 'accountHolderTreatyClaims' | 'confirmation' | 'exemptions' | 'regardedOwnerContactInformation' | 'regardedOwnerTaxInformation' | 'regardedOwnerTreatyClaims' | 'summary' | 'w8imyInstructions';
+export type StepId = 'accountHolderContactInformation' | 'accountHolderTaxInformation' | 'accountHolderClassification' | 'accountHolderTaxClarification' | 'accountHolderTreatyClaims' | 'confirmation' | 'controllingPersonDetails1' | 'controllingPersonDetails2' | 'controllingPersonDetails3' | 'controllingPersonDetails4' | 'controllingPersonDetails5' | 'exemptions' | 'regardedOwnerContactInformation' | 'regardedOwnerTaxInformation' | 'regardedOwnerTreatyClaims' | 'summary' | 'w8imyInstructions';