@taxbit/react-sdk 2.3.0-beta.0 → 2.5.0-beta.0

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

@@ -1,9 +1,9 @@
 export type ButtonKey = 'edit' | 'back' | 'next' | 'reset' | 'submit' | 'cancel' | 'hide' | 'show';
 export type BadgeKey = 'validTin' | 'invalidTin' | 'pendingTin';
-export type ErrorKey = 'countryMustBeAResidenceCountry' | 'formHasErrors' | 'invalid' | 'invalidDate' | 'invalidVat' | 'mustBeFiveOrNineDigits' | 'mustBeInDateFormat' | 'mustBeNineDigits' | 'mustBeNinoFormat' | 'mustBeABNFormat' | 'mustBeCaPostalCodeFormat' | 'mustBeInVatinFormat' | 'mustBeValidBirthDate' | 'mustBeAtLeast18' | 'mustMatchName' | 'mustNotMatchVatin' | 'required' | 'residencesMustIncludeAddressCountry' | 'residencesMustIncludeAnEUCountry' | 'residencesMustIncludeVatCountry' | 'residencesMustIncludeBusinessRegistrationCountry' | 'tooLong' | 'tooShort' | 'usTinDoesNotMatchName' | 'vatinMustNotMatchResidencyTin';
+export type StatusKey = 'doesNotMatchExpectedFormat' | 'matchesExpectedFormat' | 'countryMustBeAResidenceCountry' | 'formHasErrors' | 'invalid' | 'invalidDate' | 'invalidVat' | 'mustBeFiveOrNineDigits' | 'mustBeInDateFormat' | 'mustBeNineDigits' | 'mustBeNinoFormat' | 'mustBeABNFormat' | 'mustBeCaPostalCodeFormat' | 'mustBeInVatinFormat' | 'mustBeValidBirthDate' | 'mustBeAtLeast18' | 'mustMatchName' | 'checkFormatEntityAU' | 'checkFormatEntityCA' | 'checkFormatEntityDE' | 'checkFormatEntityES' | 'checkFormatEntityFR' | 'checkFormatEntityGB' | 'checkFormatEntityIE' | 'checkFormatEntityIT' | 'checkFormatEntityNL' | 'checkFormatEntitySG' | 'checkFormatIndividualAU' | 'checkFormatIndividualCA' | 'checkFormatIndividualDE' | 'checkFormatIndividualES' | 'checkFormatIndividualFR' | 'checkFormatIndividualGB' | 'checkFormatIndividualIE' | 'checkFormatIndividualIT' | 'checkFormatIndividualNL' | 'checkFormatIndividualSG' | 'required' | 'residencesMustIncludeAddressCountry' | 'residencesMustIncludeAnEUCountry' | 'residencesMustIncludeVatCountry' | 'residencesMustIncludeBusinessRegistrationCountry' | 'tooLong' | 'tooShort' | 'usTinDoesNotMatchName';
 export type SubOptionKey = 'accountHolderUsAccountType_SOLE_PROPRIETOR' | 'accountHolderUsAccountType_SM_LLC' | 'accountHolderUsAccountType_DISREGARDED_ENTITY' | 'accountHolderActiveNonFinancialEntityType_OTHER' | 'accountHolderActiveNonFinancialEntityType_PUBLIC_CORPORATION' | 'accountHolderSelfCertificationAccountType_FINANCIAL_INSTITUTION' | 'accountHolderSelfCertificationAccountType_ACTIVE_NON_FINANCIAL_ENTITY' | 'accountHolderSelfCertificationAccountType_PASSIVE_NON_FINANCIAL_ENTITY' | 'accountHolderAccountOwnerType_ENTITY' | 'accountHolderAccountOwnerType_INTERMEDIARY' | 'regardedOwnerAccountOwnerType_ENTITY' | 'regardedOwnerAccountOwnerType_INTERMEDIARY';
 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' | 'investmentEntityManaged_yes' | 'investmentEntityManaged_no' | 'assumesChapters3And4Responsibility_yes' | 'assumesChapters3And4Responsibility_no' | 'assumes1099Responsibility_yes' | 'assumes1099Responsibility_no' | 'usPersonElection_yes' | 'usPersonElection_no' | 'providesAdditionalDocumentation_yes' | 'providesAdditionalDocumentation_no' | 'no' | 'yes' | 'no_not_applicable' | 'ACTIVE_NON_FINANCIAL_ENTITY' | 'CENTRAL_BANK_OF_ISSUE' | 'COMPLEX_TRUST' | 'CORPORATION' | 'CUSTODIAL_INSTITUTION' | 'C_CORPORATION' | 'DEPOSITORY_INSTITUTION' | 'DISREGARDED_ENTITY' | 'ENTITY' | 'entityType_TRUST' | 'entityType_SIMILAR_TO_TRUST' | 'entityType_OTHER' | 'ESTATE' | 'FINANCIAL_INSTITUTION' | 'FOREIGN_GOVERNMENT_CONTROLLED_ENTITY' | 'FOREIGN_GOVERNMENT_INTEGRAL_PART' | 'accountHolderActiveNonFinancialEntityType_GOVERNMENT_ENTITY' | 'GRANTOR_TRUST' | 'INDIVIDUAL' | 'INTERMEDIARY' | 'QUALIFIED_INTERMEDIARY' | 'NONQUALIFIED_INTERMEDIARY' | 'TERRITORY_FINANCIAL_INSTITUTION' | 'US_BRANCH' | 'WITHHOLDING_FOREIGN_PARTNERSHIP' | 'WITHHOLDING_FOREIGN_TRUST' | 'NONWITHHOLDING_FOREIGN_PARTNERSHIP' | 'NONWITHHOLDING_FOREIGN_SIMPLE_TRUST' | 'NONWITHHOLDING_FOREIGN_GRANTOR_TRUST' | 'accountHolderActiveNonFinancialEntityType_INTERNATIONAL_ORGANIZATION' | 'INTERNATIONAL_ORGANIZATION' | 'INVESTMENT_ENTITY' | 'INSURANCE_COMPANY' | 'LLC' | 'OTHER' | 'accountHolderActiveNonFinancialEntityType_OTHER' | 'PARTNERSHIP' | 'PASSIVE_NON_FINANCIAL_ENTITY' | 'PRIVATE_FOUNDATION' | 'accountHolderActiveNonFinancialEntityType_PUBLIC_CORPORATION' | 'signatureCapacity_EXECUTOR' | 'signatureCapacity_OFFICER' | 'signatureCapacity_OTHER_CAPACITY' | 'SIMPLE_TRUST' | 'SM_LLC' | 'SOLE_PROPRIETOR' | 'S_CORPORATION' | 'TAX_EXEMPT_ORGANIZATION' | 'TRUST' | 'TRUST_ESTATE' | 'controllingPersonRole_SETTLOR' | 'controllingPersonRole_TRUSTEE' | 'controllingPersonRole_PROTECTOR' | 'controllingPersonRole_BENEFICIARY' | 'controllingPersonRole_OTHER' | 'controllingPersonRole_SETTLOR_EQUIVALENT' | 'controllingPersonRole_TRUSTEE_EQUIVALENT' | 'controllingPersonRole_PROTECTOR_EQUIVALENT' | 'controllingPersonRole_BENEFICIARY_EQUIVALENT' | 'controllingPersonRole_OTHER_EQUIVALENT' | 'controllingPersonRole_OWNER' | 'controllingPersonRole_OTHER_MEANS' | 'controllingPersonRole_SENIOR_MANAGING_OFFICIAL' | 'missingTinNotRequiredReason_NOT_ISSUED' | 'missingTinNotRequiredReason_NOT_REQUIRED' | 'missingTinNotRequiredReason_OTHER';
-export type PromptKey = TreatyClaimPrompt | 'accountHolderAccountOwnerType' | 'accountHolderIntermediaryAccountType' | 'accountHolderEntityAccountType' | 'activeNonFinancialEntityType' | 'addAdditionalResidence' | 'addControllingPerson' | 'address' | 'businessRegistrationNumber' | 'businessRegistrationCountry' | 'city' | 'cityOfBirth' | 'country' | 'countryOfBirth' | 'dateOfBirth' | 'day' | 'dbaName' | 'emailAddress' | 'exemptPayeeCode' | 'exemptFatcaCode' | 'foreignAccountType' | 'financialInstitutionType' | 'foreignTin' | 'foreignTinIsNotRequired' | 'investmentEntityManaged' | 'isIndividual' | 'iWillResubmitIfIncorrect' | 'iAmACitizenOfTheUs' | 'iAmExemptFromFatcaReporting' | 'iAmNotSubjectToBackupWithholding' | 'iAuthorizeWithholdingAgent' | 'iConfirmIncomeIsNonUs' | 'iConfirmTheBeneficialOwnerIsExempt' | 'iConfirmTheEntityIsNotAUsPerson' | 'iConfirmTheEntityIsTheBeneficialOwner' | 'iConfirmTheIndividualIsNotAUsPerson' | 'iConfirmTheIndividualIsTheBeneficialOwner' | 'iConfirmTheIndividualIsResidentOfTreatyCountry' | 'iConfirmTheTaxIdIsCorrect' | 'iDeclareStatementsAreCorrect' | 'iUnderstandTheInformationIsCovered' | 'iAcknowledgeTheInformationMayBeProvided' | 'iCertifyIAmAccountHolder' | 'iCertifyIAmAuthorizedToSignForAccountHolder' | 'iWillNotifyChangeInCircumstance' | 'mailingAddress' | 'mailingAddressIsDifferent' | 'month' | 'name' | 'nameOfDisregardedEntity' | 'nameOfEntity' | 'nameOfCCorporation' | 'nameOfCorporation' | 'nameOfIndividual' | 'nameOfIndividualSoleProprietor' | 'nameOfLlc' | 'nameOfOrganization' | 'nameOfPartnership' | 'nameOfSCorporation' | 'nameOfSmllc' | 'nameOfSmllcOwner' | 'nameOfSoleProprietor' | 'nameOfTrustEstate' | 'nameOfComplexTrust' | 'nameOfTaxExemptOrganization' | 'nameOfPrivateFoundation' | 'nameOfInternationalOrganization' | 'nameOfCentralBankOfIssue' | 'nameOfForeignGovernmentControlledEntity' | 'nameOfForeignGovernmentIntegralPart' | 'nameOfEstate' | 'nameOfQualifiedIntermediary' | 'nameOfNonqualifiedIntermediary' | 'nameOfTerritoryFinancialInstitution' | 'nameOfUsBranch' | 'nameOfWithholdingForeignPartnership' | 'nameOfWithholdingForeignTrust' | 'nameOfNonwithholdingForeignPartnership' | 'nameOfNonwithholdingForeignSimpleTrust' | 'nameOfNonwithholdingForeignGrantorTrust' | 'otherRole' | 'otherEquivalentRole' | 'ownershipPercentage' | 'managedEntityType' | 'passiveEntityType' | 'phoneNumber' | 'phoneNumberCode' | 'phoneNumberNumber' | 'province' | 'referenceNumbers' | 'regardedOwnerUsPerson' | 'regardedOwnerAccountType' | 'regardedOwnerEntityAccountType' | 'regardedOwnerIntermediaryAccountType' | 'relatedCorporation' | 'removeResidence' | 'removeControllingPerson' | 'role' | 'securitiesMarket' | 'signature' | 'signatureCapacity' | 'signatureCapacityOther' | 'smllcElection' | 'smllcOwnerAccountType' | 'smllcOwnerUsPerson' | 'countyRegion' | 'stateProvince' | 'street' | 'street2' | 'taxIdNumber' | 'taxIdNumberIsNotRequired' | 'taxIdNumberIsNotRequiredReason' | 'taxIdNumberIsNotRequiredReasonOther' | 'tin' | 'tinAuAbn' | 'tinUkCrn' | 'tinUkNino' | 'type' | 'usAccountType' | 'usLlcClassification' | 'usOtherClassification' | 'usPerson' | 'usEin' | 'usSoleProprietorEin' | 'usSsn' | 'usTin' | 'usTinIsValid' | 'usTinMatchVerification' | 'usTrustEstateEin' | 'vatIdentificationNumber' | 'vatIsNotRequired' | 'vatCountry' | 'year' | 'zip' | 'isQiCertified' | 'assumesChapters3And4Responsibility' | 'assumes1099Responsibility' | 'usPersonElection' | 'providesAdditionalDocumentation' | 'assumesChapters3And4ResponsibilityCertified' | 'assumes1099ResponsibilityCertified' | 'notAssume1099ResponsibilityCertified' | 'meetsQiRegulationsRequirementsCertified' | 'obtainsDocumentationCertified' | 'notActingAsQiCertified' | 'transmitsNqiDocumentationCertified' | 'representsWithholdingStatementsCertified' | 'isFinancialInstitutionCertified' | 'tfiUsPersonElectionCertified' | 'transmitsTfiDocumentationCertified' | 'usbPaymentsCertified' | 'usbUsPersonElectionCertified' | 'transmitsUsbDocumentationCertified' | 'isCompliantCertified' | 'entityPaymentsCertified' | 'providesWithholdingStatementCertified';
+export type PromptKey = TreatyClaimPrompt | 'accountHolderAccountOwnerType' | 'accountHolderIntermediaryAccountType' | 'accountHolderEntityAccountType' | 'activeNonFinancialEntityType' | 'addAdditionalResidence' | 'addControllingPerson' | 'address' | 'businessRegistrationNumber' | 'businessRegistrationCountry' | 'city' | 'cityOfBirth' | 'country' | 'countryOfBirth' | 'dateOfBirth' | 'day' | 'dbaName' | 'emailAddress' | 'exemptPayeeCode' | 'exemptFatcaCode' | 'foreignAccountType' | 'financialInstitutionType' | 'foreignTin' | 'foreignTinIsNotRequired' | 'investmentEntityManaged' | 'isIndividual' | 'iWillResubmitIfIncorrect' | 'iAmACitizenOfTheUs' | 'iAmExemptFromFatcaReporting' | 'iAmNotSubjectToBackupWithholding' | 'iAuthorizeWithholdingAgent' | 'iConfirmIncomeIsNonUs' | 'iConfirmTheBeneficialOwnerIsExempt' | 'iConfirmTheEntityIsNotAUsPerson' | 'iConfirmTheEntityIsTheBeneficialOwner' | 'iConfirmTheIndividualIsNotAUsPerson' | 'iConfirmTheIndividualIsTheBeneficialOwner' | 'iConfirmTheIndividualIsResidentOfTreatyCountry' | 'iConfirmTheTaxIdIsCorrect' | 'iDeclareStatementsAreCorrect' | 'iUnderstandTheInformationIsCovered' | 'iAcknowledgeTheInformationMayBeProvided' | 'iCertifyIAmAccountHolder' | 'iCertifyIAmAuthorizedToSignForAccountHolder' | 'iWillNotifyChangeInCircumstance' | 'mailingAddress' | 'mailingAddressIsDifferent' | 'month' | 'name' | 'nameOfDisregardedEntity' | 'nameOfEntity' | 'nameOfCCorporation' | 'nameOfCorporation' | 'nameOfIndividual' | 'nameOfIndividualSoleProprietor' | 'nameOfLlc' | 'nameOfOrganization' | 'nameOfPartnership' | 'nameOfSCorporation' | 'nameOfSmllc' | 'nameOfSmllcOwner' | 'nameOfSoleProprietor' | 'nameOfTrustEstate' | 'nameOfComplexTrust' | 'nameOfTaxExemptOrganization' | 'nameOfPrivateFoundation' | 'nameOfInternationalOrganization' | 'nameOfCentralBankOfIssue' | 'nameOfForeignGovernmentControlledEntity' | 'nameOfForeignGovernmentIntegralPart' | 'nameOfEstate' | 'nameOfQualifiedIntermediary' | 'nameOfNonqualifiedIntermediary' | 'nameOfTerritoryFinancialInstitution' | 'nameOfUsBranch' | 'nameOfWithholdingForeignPartnership' | 'nameOfWithholdingForeignTrust' | 'nameOfNonwithholdingForeignPartnership' | 'nameOfNonwithholdingForeignSimpleTrust' | 'nameOfNonwithholdingForeignGrantorTrust' | 'otherRole' | 'otherEquivalentRole' | 'ownershipPercentage' | 'managedEntityType' | 'passiveEntityType' | 'phoneNumber' | 'phoneNumberCode' | 'phoneNumberNumber' | 'province' | 'referenceNumbers' | 'regardedOwnerUsPerson' | 'regardedOwnerAccountType' | 'regardedOwnerEntityAccountType' | 'regardedOwnerIntermediaryAccountType' | 'relatedCorporation' | 'removeResidence' | 'removeControllingPerson' | 'role' | 'securitiesMarket' | 'signature' | 'signatureCapacity' | 'signatureCapacityOther' | 'smllcElection' | 'smllcOwnerAccountType' | 'smllcOwnerUsPerson' | 'countyRegion' | 'stateProvince' | 'street' | 'street2' | 'taxIdNumber' | 'taxIdNumberIsNotRequired' | 'taxIdNumberIsNotRequiredReason' | 'taxIdNumberIsNotRequiredReasonOther' | 'tin' | 'tinAuAbn' | 'tinUkEntity' | 'tinUkIndividual' | 'type' | 'usAccountType' | 'usLlcClassification' | 'usOtherClassification' | 'usPerson' | 'usEin' | 'usSoleProprietorEin' | 'usSsn' | 'usTin' | 'usTinIsValid' | 'usTinMatchVerification' | 'usTrustEstateEin' | 'vatIdentificationNumber' | 'vatIsNotRequired' | 'vatCountry' | 'year' | 'zip' | 'isQiCertified' | 'assumesChapters3And4Responsibility' | 'assumes1099Responsibility' | 'usPersonElection' | 'providesAdditionalDocumentation' | 'assumesChapters3And4ResponsibilityCertified' | 'assumes1099ResponsibilityCertified' | 'notAssume1099ResponsibilityCertified' | 'meetsQiRegulationsRequirementsCertified' | 'obtainsDocumentationCertified' | 'notActingAsQiCertified' | 'transmitsNqiDocumentationCertified' | 'representsWithholdingStatementsCertified' | 'isFinancialInstitutionCertified' | 'tfiUsPersonElectionCertified' | 'transmitsTfiDocumentationCertified' | 'usbPaymentsCertified' | 'usbUsPersonElectionCertified' | 'transmitsUsbDocumentationCertified' | 'isCompliantCertified' | 'entityPaymentsCertified' | 'providesWithholdingStatementCertified';
 export type SubPromptKey = TreatyClaimSubPrompt | 'accountHolderTaxResidences' | 'isQiCertified' | 'smllcElection' | 'iAmNotSubjectToBackupWithholding' | 'iConfirmIncomeIsNonUs' | 'isIndividual' | 'transmitsTfiDocumentationCertified' | 'transmitsUsbDocumentationCertified' | 'entityPaymentsCertified' | 'enterAbnWithResidency' | 'financialInstitutionType' | 'vatIdentificationNumber' | 'placeOfBirth' | 'referenceNumbers' | 'relatedCorporation' | 'role' | 'securitiesMarket' | 'signature' | 'signatureCapacityOther' | 'streetIsPermanent' | 'usPerson' | 'usTin' | 'usTinMatchVerification';
 export type TitleKey = 'accountHolder' | 'accountHolderCertifications' | 'accountHolderClassification' | 'accountHolderContactInformation' | 'accountHolderTaxInformation' | 'accountHolderAdditionalInfo' | 'accountHolderTreatyClaims' | 'accountTypeCertifications' | 'accountHolderUsTinValidation' | 'address' | 'additionalConditions' | 'carfClassificationDetails' | 'certificationStatements' | 'certify' | 'confirmation' | 'controllingPersonDetails' | 'controllingPersons' | 'controllingPerson1' | 'controllingPerson2' | 'controllingPerson3' | 'controllingPerson4' | 'controllingPerson5' | 'countryOfCitizenship' | 'countryOfIncorporation' | 'exemptions' | 'mailingAddress' | 'primaryAddress' | 'permanentAddress' | 'placeOfBirth' | 'regardedOwner' | 'regardedOwnerCertifications' | 'regardedOwnerClassification' | 'regardedOwnerContactInformation' | 'regardedOwnerTaxInformation' | 'regardedOwnerTreatyClaims' | 'regardedOwnerUsTinValidation' | 'reviewAndSubmit' | 'signature' | 'summary' | 'taxResidences' | 'taxResidence1' | 'taxResidence2' | 'taxResidence3' | 'taxResidence4' | 'taxResidence5';
 export type SubTitleKey = 'controllingPersonDetails' | 'taxResidences' | 'permanentAddress' | 'taxInformationTreatyClaims';

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

@@ -1,4 +1,4 @@
-import { BadgeKey, ButtonKey, ErrorKey, OptionKey, PromptKey, SubOptionKey, SubPromptKey, SubTitleKey, TextKey, TitleKey } from './LocalizationKey';
+import { BadgeKey, ButtonKey, OptionKey, PromptKey, StatusKey, SubOptionKey, SubPromptKey, SubTitleKey, TextKey, TitleKey } from './LocalizationKey';
 
 export type PropertyFile = {
     button: {
@@ -7,8 +7,8 @@ export type PropertyFile = {
     badge: {
         [key in BadgeKey]: string;
     };
-    error: {
-        [key in ErrorKey]: string;
+    status: {
+        [key in StatusKey]: string;
     };
     prompt: {
         [key in PromptKey]: string;
@@ -34,12 +34,12 @@ export type PropertyFile = {
 };
 export type ForeignPropertyFile = {
     button: PropertyFile['button'];
-    prompt: Pick<PropertyFile['prompt'], 'addAdditionalResidence' | 'addControllingPerson' | 'foreignAccountType' | 'financialInstitutionType' | 'activeNonFinancialEntityType' | 'passiveEntityType' | 'managedEntityType' | 'investmentEntityManaged' | 'iUnderstandTheInformationIsCovered' | 'iAcknowledgeTheInformationMayBeProvided' | 'iCertifyIAmAccountHolder' | 'iCertifyIAmAuthorizedToSignForAccountHolder' | 'iDeclareStatementsAreCorrect' | 'iWillNotifyChangeInCircumstance' | 'otherRole' | 'otherEquivalentRole' | 'ownershipPercentage' | 'relatedCorporation' | 'removeControllingPerson' | 'role' | 'securitiesMarket' | 'taxIdNumberIsNotRequiredReason' | 'taxIdNumberIsNotRequiredReasonOther' | 'address' | 'mailingAddressIsDifferent' | 'businessRegistrationCountry' | 'businessRegistrationNumber' | 'city' | 'cityOfBirth' | 'country' | 'countryOfBirth' | 'dateOfBirth' | 'day' | 'emailAddress' | 'isIndividual' | 'month' | 'name' | 'nameOfEntity' | 'nameOfIndividual' | 'phoneNumber' | 'phoneNumberCode' | 'phoneNumberNumber' | 'province' | 'removeResidence' | 'countyRegion' | 'stateProvince' | 'street' | 'street2' | 'signature' | 'signatureCapacity' | 'signatureCapacityOther' | 'taxIdNumber' | 'taxIdNumberIsNotRequired' | 'tin' | 'tinUkCrn' | 'tinUkNino' | 'type' | 'usTin' | 'vatCountry' | 'vatIdentificationNumber' | 'vatIsNotRequired' | 'year' | 'zip'>;
+    prompt: Pick<PropertyFile['prompt'], 'addAdditionalResidence' | 'addControllingPerson' | 'foreignAccountType' | 'financialInstitutionType' | 'activeNonFinancialEntityType' | 'passiveEntityType' | 'managedEntityType' | 'investmentEntityManaged' | 'iUnderstandTheInformationIsCovered' | 'iAcknowledgeTheInformationMayBeProvided' | 'iCertifyIAmAccountHolder' | 'iCertifyIAmAuthorizedToSignForAccountHolder' | 'iDeclareStatementsAreCorrect' | 'iWillNotifyChangeInCircumstance' | 'otherRole' | 'otherEquivalentRole' | 'ownershipPercentage' | 'relatedCorporation' | 'removeControllingPerson' | 'role' | 'securitiesMarket' | 'taxIdNumberIsNotRequiredReason' | 'taxIdNumberIsNotRequiredReasonOther' | 'address' | 'mailingAddressIsDifferent' | 'businessRegistrationCountry' | 'businessRegistrationNumber' | 'city' | 'cityOfBirth' | 'country' | 'countryOfBirth' | 'dateOfBirth' | 'day' | 'emailAddress' | 'isIndividual' | 'month' | 'name' | 'nameOfEntity' | 'nameOfIndividual' | 'phoneNumber' | 'phoneNumberCode' | 'phoneNumberNumber' | 'province' | 'removeResidence' | 'countyRegion' | 'stateProvince' | 'street' | 'street2' | 'signature' | 'signatureCapacity' | 'signatureCapacityOther' | 'taxIdNumber' | 'taxIdNumberIsNotRequired' | 'tin' | 'tinUkEntity' | 'tinUkIndividual' | 'type' | 'usTin' | 'vatCountry' | 'vatIdentificationNumber' | 'vatIsNotRequired' | 'year' | 'zip'>;
     subPrompt: Pick<PropertyFile['subPrompt'], 'financialInstitutionType' | 'isIndividual' | 'placeOfBirth' | 'relatedCorporation' | 'role' | 'securitiesMarket' | 'signatureCapacityOther' | 'streetIsPermanent' | 'vatIdentificationNumber'>;
     subTitle: Pick<PropertyFile['subTitle'], 'taxResidences' | 'controllingPersonDetails' | 'permanentAddress'>;
     title: Pick<PropertyFile['title'], 'certify' | 'carfClassificationDetails' | 'controllingPersonDetails' | 'controllingPersons' | 'controllingPerson1' | 'controllingPerson2' | 'controllingPerson3' | 'controllingPerson4' | 'controllingPerson5' | 'accountHolder' | 'accountHolderClassification' | 'accountHolderContactInformation' | 'accountHolderTaxInformation' | 'accountHolderAdditionalInfo' | 'address' | 'confirmation' | 'countryOfCitizenship' | 'countryOfIncorporation' | 'placeOfBirth' | 'mailingAddress' | 'permanentAddress' | 'primaryAddress' | 'summary' | 'taxResidences' | 'taxResidence1' | 'taxResidence2' | 'taxResidence3' | 'taxResidence4' | 'taxResidence5'>;
     text: Pick<PropertyFile['text'], 'interviewIsComplete' | 'notRequired' | 'notRequiredOrNotIssued' | 'retrievingInterviewStatus' | 'taxDocumentationSaved' | 'iCertifyIsCorrect' | 'iCertifyHaveCapacity'>;
-    error: Pick<PropertyFile['error'], 'countryMustBeAResidenceCountry' | 'formHasErrors' | 'invalid' | 'invalidDate' | 'invalidVat' | 'mustBeABNFormat' | 'mustBeAtLeast18' | 'mustBeFiveOrNineDigits' | 'mustBeInDateFormat' | 'mustBeInVatinFormat' | 'mustBeNineDigits' | 'mustBeNinoFormat' | 'mustBeCaPostalCodeFormat' | 'mustBeValidBirthDate' | 'mustNotMatchVatin' | 'required' | 'residencesMustIncludeAddressCountry' | 'residencesMustIncludeAnEUCountry' | 'residencesMustIncludeVatCountry' | 'residencesMustIncludeBusinessRegistrationCountry' | 'tooLong' | 'tooShort' | 'vatinMustNotMatchResidencyTin'>;
+    status: Pick<PropertyFile['status'], 'countryMustBeAResidenceCountry' | 'formHasErrors' | 'invalid' | 'invalidDate' | 'invalidVat' | 'mustBeABNFormat' | 'mustBeAtLeast18' | 'mustBeFiveOrNineDigits' | 'mustBeInDateFormat' | 'mustBeInVatinFormat' | 'mustBeNineDigits' | 'mustBeNinoFormat' | 'mustBeCaPostalCodeFormat' | 'mustBeValidBirthDate' | 'required' | 'residencesMustIncludeAddressCountry' | 'residencesMustIncludeAnEUCountry' | 'residencesMustIncludeVatCountry' | 'residencesMustIncludeBusinessRegistrationCountry' | 'tooLong' | 'tooShort'>;
     option: Pick<PropertyFile['option'], 'no' | 'yes' | 'isIndividual_yes' | 'isIndividual_no' | 'investmentEntityManaged_yes' | 'investmentEntityManaged_no' | 'ACTIVE_NON_FINANCIAL_ENTITY' | 'PASSIVE_NON_FINANCIAL_ENTITY' | 'CUSTODIAL_INSTITUTION' | 'accountHolderActiveNonFinancialEntityType_GOVERNMENT_ENTITY' | 'INSURANCE_COMPANY' | 'INVESTMENT_ENTITY' | 'entityType_TRUST' | 'entityType_SIMILAR_TO_TRUST' | 'entityType_OTHER' | 'accountHolderActiveNonFinancialEntityType_PUBLIC_CORPORATION' | 'accountHolderActiveNonFinancialEntityType_OTHER' | 'accountHolderActiveNonFinancialEntityType_INTERNATIONAL_ORGANIZATION' | 'signatureCapacity_EXECUTOR' | 'signatureCapacity_OFFICER' | 'signatureCapacity_OTHER_CAPACITY' | 'DEPOSITORY_INSTITUTION' | 'FINANCIAL_INSTITUTION' | 'controllingPersonRole_SETTLOR' | 'controllingPersonRole_TRUSTEE' | 'controllingPersonRole_PROTECTOR' | 'controllingPersonRole_BENEFICIARY' | 'controllingPersonRole_OTHER' | 'controllingPersonRole_SETTLOR_EQUIVALENT' | 'controllingPersonRole_TRUSTEE_EQUIVALENT' | 'controllingPersonRole_PROTECTOR_EQUIVALENT' | 'controllingPersonRole_BENEFICIARY_EQUIVALENT' | 'controllingPersonRole_OTHER_EQUIVALENT' | 'controllingPersonRole_OWNER' | 'controllingPersonRole_OTHER_MEANS' | 'controllingPersonRole_SENIOR_MANAGING_OFFICIAL' | 'missingTinNotRequiredReason_NOT_ISSUED' | 'missingTinNotRequiredReason_NOT_REQUIRED' | 'missingTinNotRequiredReason_OTHER'>;
     subOption: Pick<PropertyFile['subOption'], 'accountHolderActiveNonFinancialEntityType_PUBLIC_CORPORATION' | 'accountHolderActiveNonFinancialEntityType_OTHER' | 'accountHolderSelfCertificationAccountType_FINANCIAL_INSTITUTION' | 'accountHolderSelfCertificationAccountType_ACTIVE_NON_FINANCIAL_ENTITY' | 'accountHolderSelfCertificationAccountType_PASSIVE_NON_FINANCIAL_ENTITY'>;
 };
@@ -50,6 +50,6 @@ export type PartialForeignPropertyFile = {
     subTitle?: Partial<ForeignPropertyFile['subTitle']>;
     title?: Partial<ForeignPropertyFile['title']>;
     text?: Partial<ForeignPropertyFile['text']>;
-    error?: Partial<ForeignPropertyFile['error']>;
+    status?: Partial<ForeignPropertyFile['status']>;
     option?: Partial<ForeignPropertyFile['option']>;
 };

package/dist/src/i18n/utils/getText.d.ts

@@ -1,13 +1,13 @@
 import { Locale, TaxDocumentation } from '../../types';
-import { ButtonKey, ErrorKey, OptionKey, PromptKey, SubOptionKey, SubPromptKey } from '../types';
+import { ButtonKey, OptionKey, PromptKey, StatusKey, SubOptionKey, SubPromptKey } from '../types';
 
-export declare const getPromptText: (key: PromptKey, data: TaxDocumentation, locale: Locale | undefined) => string;
-export declare const getSubPromptText: (key: SubPromptKey, data: TaxDocumentation, locale: Locale | undefined) => string;
-export declare const getErrorText: (key: ErrorKey, data: TaxDocumentation, locale: Locale | undefined) => string;
-export declare const getBadgeText: (key: string, data: TaxDocumentation, locale: Locale | undefined) => string;
-export declare const getTextText: (key: string, data: TaxDocumentation, locale: Locale | undefined) => string;
-export declare const getTitleText: (key: string, data: TaxDocumentation, locale: Locale | undefined) => string;
-export declare const getSubTitleText: (key: string, data: TaxDocumentation, locale: Locale | undefined) => string;
-export declare const getButtonText: (key: ButtonKey, data: TaxDocumentation, locale: Locale | undefined) => string;
-export declare const getOptionText: (key: OptionKey | undefined, data: TaxDocumentation, locale: Locale | undefined) => string;
-export declare const getSubOptionText: (key: SubOptionKey | undefined, data: TaxDocumentation, locale: Locale | undefined) => string | undefined;
+export declare const getPromptText: (key: PromptKey, locale: Locale | undefined, fields?: TaxDocumentation) => string;
+export declare const getSubPromptText: (key: SubPromptKey, locale: Locale | undefined) => string;
+export declare const getStatusText: (key: StatusKey, locale: Locale | undefined) => string;
+export declare const getBadgeText: (key: string, locale: Locale | undefined) => string;
+export declare const getTextText: (key: string, locale: Locale | undefined) => string;
+export declare const getTitleText: (key: string, locale: Locale | undefined) => string;
+export declare const getSubTitleText: (key: string, locale: Locale | undefined) => string;
+export declare const getButtonText: (key: ButtonKey, locale: Locale | undefined) => string;
+export declare const getOptionText: (key: OptionKey | undefined, locale: Locale | undefined) => string;
+export declare const getSubOptionText: (key: SubOptionKey | undefined, locale: Locale | undefined) => string | undefined;

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

@@ -1,22 +1,25 @@
 import { QuestionnaireProp } from 'types';
 
+type Environment = 'PRODUCTION' | 'STAGING';
+type Region = 'US' | 'EU' | string;
 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 US_TIN_VALIDATION_PATH = "embedded-validations/us-tin";
 export declare const api: {
     taxDocumentationSubmissions: {
-        post: (environment: "PRODUCTION" | "STAGING") => string;
-        get: (environment: "PRODUCTION" | "STAGING", questionnaire: QuestionnaireProp) => string;
+        post: (environment: Environment, region: Region | undefined, proxyDomain: string | undefined) => string;
+        get: (environment: Environment, questionnaire: QuestionnaireProp, region: Region | undefined, proxyDomain: string | undefined) => string;
     };
     taxDocumentationStatus: {
-        get: (environment: "PRODUCTION" | "STAGING") => string;
+        get: (environment: Environment, region: Region | undefined, proxyDomain: string | undefined) => string;
     };
     taxDocument: {
-        post: (environment: "PRODUCTION" | "STAGING") => string;
-        get: (documentId: string, environment: "PRODUCTION" | "STAGING") => string;
+        post: (environment: Environment, region: Region | undefined, proxyDomain: string | undefined) => string;
+        get: (documentId: string, environment: Environment, region?: Region, proxyDomain?: string) => string;
     };
     usTinValidation: {
-        post: (environment: "PRODUCTION" | "STAGING") => string;
+        post: (environment: Environment, region: Region | undefined, proxyDomain: string | undefined) => string;
     };
 };
+export {};

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

@@ -17,6 +17,7 @@ export declare const mockApi: {
         get: {
             success: (options?: ResponseOptions) => import('msw').HttpHandler;
             unauthorized: (options?: ResponseOptions) => import('msw').HttpHandler;
+            forbidden: (options?: ResponseOptions) => import('msw').HttpHandler;
         };
     };
     taxDocument: {

package/dist/src/types/client/ClientTaxDocumentationStatus.d.ts

@@ -1,6 +1,11 @@
+type IssueDetail = {
+    field: string;
+    description: string;
+};
 type QuestionnaireIssue = {
-    issueType: 'CARE_OF_PERMANENT_ADDRESS' | 'PO_BOX_PERMANENT_ADDRESS' | 'US_PERMANENT_ADDRESS' | 'TREATY_COUNTRY_MISMATCH' | 'US_INDICIA' | 'WITHHOLDING_DOCUMENTATION' | 'CHANGE_IN_CIRCUMSTANCES';
+    issueType: 'CARE_OF_PERMANENT_ADDRESS' | 'CHANGE_IN_CIRCUMSTANCES' | 'INCOMPLETE_DATA' | 'INCOMPLETE_ADDRESS' | 'PO_BOX_PERMANENT_ADDRESS' | 'TREATY_COUNTRY_MISMATCH' | 'US_INDICIA' | 'US_PERMANENT_ADDRESS' | 'WITHHOLDING_DOCUMENTATION';
     createdAt: string;
+    details: IssueDetail[];
 };
 export type ClientTaxDocumentationStatus = {
     dpsQuestionnaire?: {

package/dist/src/types/server/TaxDocumentationStatus.d.ts

@@ -1,6 +1,11 @@
+type IssueDetail = {
+    field: string;
+    description: string;
+};
 type Issue = {
-    issue_type: 'CARE_OF_PERMANENT_ADDRESS' | 'PO_BOX_PERMANENT_ADDRESS' | 'US_PERMANENT_ADDRESS' | 'TREATY_COUNTRY_MISMATCH' | 'US_INDICIA' | 'WITHHOLDING_DOCUMENTATION' | 'CHANGE_IN_CIRCUMSTANCES';
+    issue_type: 'CARE_OF_PERMANENT_ADDRESS' | 'CHANGE_IN_CIRCUMSTANCES' | 'INCOMPLETE_DATA' | 'INCOMPLETE_ADDRESS' | 'PO_BOX_PERMANENT_ADDRESS' | 'TREATY_COUNTRY_MISMATCH' | 'US_INDICIA' | 'US_PERMANENT_ADDRESS' | 'WITHHOLDING_DOCUMENTATION';
     created_at: string;
+    details: IssueDetail[];
 };
 export type TaxDocumentationStatus = {
     dps_questionnaire?: {

package/dist/src/ui/TextInput/TextInput.d.ts

@@ -6,7 +6,6 @@ export type TextInputProps = {
     className?: string;
     onChange?: (val: string) => string;
     disabled?: boolean;
-    children?: React.ReactNode;
     defaultValue?: string;
 };
-export declare const TextInput: ({ name, className, onChange, children, disabled, defaultValue, }: TextInputProps) => React.JSX.Element;
+export declare const TextInput: ({ name, className, onChange, disabled, defaultValue, }: TextInputProps) => React.JSX.Element;

package/dist/src/utils/getFieldsState.d.ts

@@ -7,7 +7,7 @@ type Options = {
     treatyClaims?: boolean;
     externalValidations?: ExternalValidations;
 };
-export declare const getFieldsState: (fields: TaxDocumentation, questionnaire?: QuestionnaireProp, options?: Options) => {
+export declare const getFieldsState: (fields?: TaxDocumentation, questionnaire?: QuestionnaireProp, options?: Options) => {
     hasNoEuTaxId: boolean;
     hasEuResidence: boolean;
     hasAuResidence: boolean;
@@ -46,6 +46,6 @@ export declare const getFieldsState: (fields: TaxDocumentation, questionnaire?:
         tin: string | undefined;
         tinNotRequired: "yes" | undefined;
     }[];
-    hasUsTinValidationError: import('../i18n/types').ErrorKey[] | undefined;
+    hasUsTinValidationError: import('../i18n/types').StatusKey[] | undefined;
 };
 export {};

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

@@ -1,6 +1,7 @@
 export * from './getSteps';
-export * from './invalidFields/getInvalidFields.ts';
-export * from './invalidFields/invalidFieldRules.ts';
-export * from './requiredFields/getRequiredFields.ts';
-export * from './supportedFields/getSupportedFields.ts';
-export * from './visibleFields/getVisibleFields.ts';
+export * from './invalidFields/getInvalidFields';
+export * from './invalidFields/invalidFieldRules';
+export * from './requiredFields/getRequiredFields';
+export * from './statusFields/getStatusFields.ts';
+export * from './supportedFields/getSupportedFields';
+export * from './visibleFields/getVisibleFields';

package/dist/src/validations/invalidFields/getInvalidAddressFields.d.ts

@@ -1,5 +1,5 @@
-import { FormUIValidations } from './invalidFieldRules.ts';
+import { QuestionnaireValidations } from './invalidFieldRules.ts';
 
 type Prefix = 'accountHolder' | 'accountHolderMailing' | 'regardedOwner' | 'regardedOwnerMailing' | 'controllingPerson1' | 'controllingPerson1Mailing' | 'controllingPerson2' | 'controllingPerson2Mailing' | 'controllingPerson3' | 'controllingPerson3Mailing' | 'controllingPerson4' | 'controllingPerson4Mailing' | 'controllingPerson5' | 'controllingPerson5Mailing';
-export declare const getInvalidAddressRules: (prefix: Prefix) => FormUIValidations;
+export declare const getInvalidAddressRules: (prefix: Prefix) => QuestionnaireValidations;
 export {};

package/dist/src/validations/invalidFields/getInvalidControllingPersonsFields.d.ts

@@ -1,3 +1,3 @@
-import { FormUIValidations } from './invalidFieldRules';
+import { QuestionnaireValidations } from './invalidFieldRules';
 
-export declare const getInvalidControllingPersonsFields: () => FormUIValidations;
+export declare const getInvalidControllingPersonsFields: () => QuestionnaireValidations;

package/dist/src/validations/invalidFields/getInvalidFields.d.ts

@@ -1,4 +1,4 @@
-import { TaxDocumentationErrorFile } from '../../contexts';
+import { TaxDocumentationErrorMessagesMap } from '../../contexts';
 import { QuestionnaireProp, TaxDocumentation } from '../../types';
 import { ExternalValidations } from '../../types/client';
 
@@ -7,5 +7,5 @@ type Options = {
     treatyClaims?: boolean;
     externalValidations?: ExternalValidations;
 };
-export declare const getInvalidFields: (fields: TaxDocumentation, questionnaire: QuestionnaireProp, options?: Options) => TaxDocumentationErrorFile;
+export declare const getInvalidFields: (fields: TaxDocumentation, questionnaire: QuestionnaireProp, options?: Options) => TaxDocumentationErrorMessagesMap;
 export {};

package/dist/src/validations/invalidFields/getInvalidTaxResidencyFields.d.ts

@@ -1,5 +1,5 @@
-import { FormUIValidations } from './invalidFieldRules.ts';
+import { QuestionnaireValidations } from './invalidFieldRules.ts';
 
 type Prefix = 'accountHolder' | 'controllingPerson1' | 'controllingPerson2' | 'controllingPerson3' | 'controllingPerson4' | 'controllingPerson5';
-export declare const getInvalidTaxResidencyFields: (prefix: Prefix) => FormUIValidations;
+export declare const getInvalidTaxResidencyFields: (prefix: Prefix) => QuestionnaireValidations;
 export {};

package/dist/src/validations/invalidFields/invalidFieldRules.d.ts

@@ -1,15 +1,17 @@
-import { ErrorKey } from 'i18n/types';
+import { StatusKey } from 'i18n/types';
 import { TaxDocumentation, TaxDocumentationKey } from 'types/TaxDocumentation';
+import { QuestionnaireProp } from '../../types';
 import { ExternalValidations } from '../../types/client';
 
 type Options = {
     treatyClaims?: boolean;
     realTimeTinValidation?: boolean;
     externalValidations?: ExternalValidations;
+    questionnaire?: QuestionnaireProp;
 };
-export type FormUIValidation = (fields: TaxDocumentation, options?: Options) => ErrorKey[] | undefined;
-export type FormUIValidations = {
+export type FormUIValidation = (fields: TaxDocumentation, options?: Options) => StatusKey[] | undefined;
+export type QuestionnaireValidations = {
     [key in TaxDocumentationKey]?: FormUIValidation;
 };
-export declare const invalidFieldRules: FormUIValidations;
+export declare const invalidFieldRules: QuestionnaireValidations;
 export {};

package/dist/src/validations/requiredFields/getRequiredControllingPersonFields.d.ts

@@ -1,4 +1,4 @@
-import { TaxDocumentationPropertyFile } from '../../contexts';
+import { TaxDocumentationBooleanMap } from '../../contexts';
 import { TaxDocumentation } from '../../types';
 
-export declare const getRequiredControllingPersonFields: (fields: TaxDocumentation, isSelfCertification: boolean) => Partial<TaxDocumentationPropertyFile>;
+export declare const getRequiredControllingPersonFields: (fields: TaxDocumentation, isSelfCertification: boolean) => Partial<TaxDocumentationBooleanMap>;

package/dist/src/validations/requiredFields/getRequiredFields.d.ts

@@ -1,9 +1,9 @@
-import { TaxDocumentationPropertyFile } from '../../contexts';
+import { TaxDocumentationBooleanMap } from '../../contexts';
 import { QuestionnaireProp, TaxDocumentation } from '../../types';
 
 type Options = {
     treatyClaims?: boolean;
     realTimeTinValidation?: boolean;
 };
-export declare const getRequiredFields: (fields: TaxDocumentation, questionnaire: QuestionnaireProp, options?: Options) => TaxDocumentationPropertyFile;
+export declare const getRequiredFields: (fields: TaxDocumentation, questionnaire: QuestionnaireProp, options?: Options) => TaxDocumentationBooleanMap;
 export {};

package/dist/src/validations/statusFields/getStatusFields.d.ts

@@ -0,0 +1,4 @@
+import { TaxDocumentationErrorMessagesMap } from '../../contexts';
+import { TaxDocumentation } from '../../types';
+
+export declare const getStatusFields: (fields: TaxDocumentation) => TaxDocumentationErrorMessagesMap;

package/dist/src/validations/statusFields/statusFieldRules.d.ts

@@ -0,0 +1,8 @@
+import { StatusKey } from '../../i18n/types';
+import { TaxDocumentation, TaxDocumentationKey } from '../../types';
+
+export type GetMessageFunction = (fields: TaxDocumentation) => StatusKey[] | undefined;
+export type GetMessageFunctions = {
+    [key in TaxDocumentationKey]?: GetMessageFunction;
+};
+export declare const statusFieldRules: GetMessageFunctions;

package/dist/src/validations/supportedFields/getSupportedAddressFields.d.ts

@@ -1,8 +1,8 @@
-import { TaxDocumentationPropertyFile } from '../../contexts';
+import { TaxDocumentationBooleanMap } from '../../contexts';
 
 declare const iterate5: readonly ["1", "2", "3", "4", "5"];
 type Iterate5 = (typeof iterate5)[number];
 type ControllingPersonPrefix = `controllingPerson${Iterate5}`;
 type AddressPrefix = 'accountHolder' | 'accountHolderMailing' | 'regardedOwner' | 'regardedOwnerMailing' | ControllingPersonPrefix | `${ControllingPersonPrefix}Mailing`;
-export declare const getSupportedAddressFields: (prefix: AddressPrefix, isSupported: boolean) => Partial<TaxDocumentationPropertyFile>;
+export declare const getSupportedAddressFields: (prefix: AddressPrefix, isSupported: boolean) => Partial<TaxDocumentationBooleanMap>;
 export {};

package/dist/src/validations/supportedFields/getSupportedControllingPersonFields.d.ts

@@ -1,7 +1,7 @@
-import { TaxDocumentationPropertyFile } from '../../contexts';
+import { TaxDocumentationBooleanMap } from '../../contexts';
 
 declare const iterate5: readonly ["1", "2", "3", "4", "5"];
 type Iterate5 = (typeof iterate5)[number];
 type ControllingPersonPrefix = `controllingPerson${Iterate5}`;
-export declare const getSupportedControllingPersonFields: (prefix: ControllingPersonPrefix, isSupported: boolean) => Partial<TaxDocumentationPropertyFile>;
+export declare const getSupportedControllingPersonFields: (prefix: ControllingPersonPrefix, isSupported: boolean) => Partial<TaxDocumentationBooleanMap>;
 export {};

package/dist/src/validations/supportedFields/getSupportedFields.d.ts

@@ -1,9 +1,9 @@
 import { QuestionnaireProp } from 'types';
-import { TaxDocumentationPropertyFile } from '../../contexts';
+import { TaxDocumentationBooleanMap } from '../../contexts';
 
 type Options = {
     treatyClaims?: boolean;
     realTimeTinValidation?: boolean;
 };
-export declare const getSupportedFields: (questionnaire: QuestionnaireProp, options?: Options) => Partial<TaxDocumentationPropertyFile>;
+export declare const getSupportedFields: (questionnaire: QuestionnaireProp, options?: Options) => Partial<TaxDocumentationBooleanMap>;
 export {};

package/dist/src/validations/supportedFields/getSupportedTaxResidenceFields.d.ts

@@ -1,8 +1,8 @@
-import { TaxDocumentationPropertyFile } from '../../contexts';
+import { TaxDocumentationBooleanMap } from '../../contexts';
 
 declare const iterate5: readonly ["1", "2", "3", "4", "5"];
 type Iterate5 = (typeof iterate5)[number];
 type ControllingPersonPrefix = `controllingPerson${Iterate5}`;
 type ResidencePrefix = 'accountHolder' | ControllingPersonPrefix;
-export declare const getSupportedTaxResidenceFields: (prefix: ResidencePrefix, isSupported: boolean, hasReason?: boolean) => Partial<TaxDocumentationPropertyFile>;
+export declare const getSupportedTaxResidenceFields: (prefix: ResidencePrefix, isSupported: boolean, hasReason?: boolean) => Partial<TaxDocumentationBooleanMap>;
 export {};

package/dist/src/validations/visibleFields/__tests__/utils.d.ts

@@ -1,3 +1,3 @@
-import { TaxDocumentationPropertyFile } from '../../../contexts';
+import { TaxDocumentationBooleanMap } from '../../../contexts';
 
-export declare const getVisibleFieldsArray: (visibleFields: TaxDocumentationPropertyFile) => string[];
+export declare const getVisibleFieldsArray: (visibleFields: TaxDocumentationBooleanMap) => string[];

package/dist/src/validations/visibleFields/getVisibleAddressFields.d.ts

@@ -1,5 +1,5 @@
-import { TaxDocumentationPropertyFile } from '../../contexts';
+import { TaxDocumentationBooleanMap } from '../../contexts';
 
 type Prefix = 'accountHolderAddress' | 'accountHolderMailingAddress' | 'regardedOwnerAddress' | 'regardedOwnerMailingAddress' | 'controllingPerson1Address' | 'controllingPerson2Address' | 'controllingPerson3Address' | 'controllingPerson4Address' | 'controllingPerson5Address' | 'controllingPerson1MailingAddress' | 'controllingPerson2MailingAddress' | 'controllingPerson3MailingAddress' | 'controllingPerson4MailingAddress' | 'controllingPerson5MailingAddress';
-export declare const getVisibleAddressFields: (prefix: Prefix, showFields: boolean) => Partial<TaxDocumentationPropertyFile>;
+export declare const getVisibleAddressFields: (prefix: Prefix, showFields: boolean) => Partial<TaxDocumentationBooleanMap>;
 export {};

package/dist/src/validations/visibleFields/getVisibleControllingPersonFields.d.ts

@@ -1,4 +1,4 @@
-import { TaxDocumentationPropertyFile } from '../../contexts';
+import { TaxDocumentationBooleanMap } from '../../contexts';
 import { TaxDocumentation } from '../../types';
 
-export declare const getVisibleControllingPersonFields: (fields: TaxDocumentation, isSupported: boolean) => Partial<TaxDocumentationPropertyFile>;
+export declare const getVisibleControllingPersonFields: (fields: TaxDocumentation, isSupported: boolean) => Partial<TaxDocumentationBooleanMap>;

package/dist/src/validations/visibleFields/getVisibleFields.d.ts

@@ -1,5 +1,5 @@
 import { QuestionnaireProp, TaxDocumentation } from 'types';
-import { TaxDocumentationPropertyFile } from '../../contexts';
+import { TaxDocumentationBooleanMap } from '../../contexts';
 import { UsTinValidationAttempt } from '../../hooks';
 
 type Options = {
@@ -7,5 +7,5 @@ type Options = {
     usTinValidations?: UsTinValidationAttempt[];
     realTimeTinValidation?: boolean;
 };
-export declare const getVisibleFields: (fields: TaxDocumentation | undefined, questionnaire: QuestionnaireProp, options?: Options) => TaxDocumentationPropertyFile;
+export declare const getVisibleFields: (fields: TaxDocumentation | undefined, questionnaire: QuestionnaireProp, options?: Options) => TaxDocumentationBooleanMap;
 export {};

package/dist/src/widgets/TaxbitQuestionnaire/TaxbitQuestionnaire.d.ts

@@ -3,7 +3,7 @@ import { default as React } from 'react';
 import { Locale, QuestionnaireProp } from '../../types';
 import { TaxbitQuestionnairePersistProps } from '../TaxbitQuestionnairePersist';
 
-export type TaxbitQuestionnaireProps = {
+type BaseProps = {
     data?: ClientTaxDocumentation;
     language?: Locale;
     questionnaire: QuestionnaireProp;
@@ -12,7 +12,8 @@ export type TaxbitQuestionnaireProps = {
     onSubmit?: TaxbitQuestionnairePersistProps['onSubmit'];
     dateFormat?: TaxbitQuestionnairePersistProps['dateFormat'];
     realTimeTinValidation?: TaxbitQuestionnairePersistProps['realTimeTinValidation'];
-} & ({
+};
+type DemoProps = {
     demoMode: true;
     bearerToken?: never;
     onError?: never;
@@ -20,13 +21,27 @@ export type TaxbitQuestionnaireProps = {
     onSettled?: never;
     onSuccess?: never;
     staging?: never;
-} | {
-    demoMode?: false | undefined;
+    region?: never;
+    proxyDomain?: never;
+};
+type AuthenticatedBase = {
+    demoMode?: false;
     bearerToken: TaxbitQuestionnairePersistProps['bearerToken'];
     onError?: TaxbitQuestionnairePersistProps['onError'];
     loadingComponent?: TaxbitQuestionnairePersistProps['loadingComponent'];
     onSettled?: TaxbitQuestionnairePersistProps['onSettled'];
     onSuccess?: TaxbitQuestionnairePersistProps['onSuccess'];
+};
+type RegionMode = {
+    region?: TaxbitQuestionnairePersistProps['region'];
+    proxyDomain?: never;
     staging?: TaxbitQuestionnairePersistProps['staging'];
-});
-export declare const TaxbitQuestionnaire: ({ bearerToken, data, demoMode, language, onError, loadingComponent, onProgress, onSettled, onSubmit, onSuccess, questionnaire, staging, treatyClaims, dateFormat, realTimeTinValidation, }: TaxbitQuestionnaireProps) => React.JSX.Element;
+};
+type ProxyMode = {
+    proxyDomain: TaxbitQuestionnairePersistProps['proxyDomain'];
+    region?: never;
+    staging?: never;
+};
+export type TaxbitQuestionnaireProps = (BaseProps & DemoProps) | (BaseProps & AuthenticatedBase & RegionMode) | (BaseProps & AuthenticatedBase & ProxyMode);
+export declare const TaxbitQuestionnaire: ({ bearerToken, data, demoMode, language, onError, loadingComponent, onProgress, onSettled, onSubmit, onSuccess, questionnaire, staging, treatyClaims, dateFormat, realTimeTinValidation, region, proxyDomain, }: TaxbitQuestionnaireProps) => React.JSX.Element;
+export {};

package/dist/src/widgets/TaxbitQuestionnairePersist/TaxbitQuestionnairePersist.d.ts

@@ -6,4 +6,4 @@ export type TaxbitQuestionnairePersistProps = UseTaxDocumentationProps & UseTaxb
     loadingComponent?: React.ReactNode;
     treatyClaims?: boolean;
 };
-export declare const TaxbitQuestionnairePersist: ({ staging, data, bearerToken, language, questionnaire, loadingComponent, onProgress, onSubmit, onSettled, onSuccess, onError, treatyClaims, dateFormat, realTimeTinValidation, }: TaxbitQuestionnairePersistProps) => string | number | bigint | true | Iterable<React.ReactNode> | Promise<string | number | bigint | boolean | React.ReactPortal | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | null | undefined> | React.JSX.Element;
+export declare const TaxbitQuestionnairePersist: ({ staging, data, bearerToken, language, questionnaire, loadingComponent, onProgress, onSubmit, onSettled, onSuccess, onError, treatyClaims, dateFormat, realTimeTinValidation, region, proxyDomain, }: TaxbitQuestionnairePersistProps) => string | number | bigint | true | Iterable<React.ReactNode> | Promise<string | number | bigint | boolean | React.ReactPortal | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | null | undefined> | React.JSX.Element;

package/dist/src/widgets/TaxbitQuestionnairePersist/useTaxbitPersist.d.ts

@@ -11,8 +11,10 @@ export type UseTaxbitPersistProps = {
     onSettled?: (data: ClientTaxDocumentation) => void | Promise<void>;
     onError?: (error: Error) => void | Promise<void>;
     onSubmit?: (data: ClientTaxDocumentation) => void | Promise<void>;
+    region?: 'US' | 'EU' | string;
+    proxyDomain?: string;
 };
-export declare const useTaxbitPersist: ({ bearerToken, data, onError, onSettled, onSubmit, onSuccess, questionnaire, staging, }: UseTaxbitPersistProps) => {
+export declare const useTaxbitPersist: ({ bearerToken, data, onError, onSettled, onSubmit, onSuccess, questionnaire, staging, region, proxyDomain, }: UseTaxbitPersistProps) => {
     handleOnSubmit: (data: SignedClientTaxDocumentation) => Promise<void>;
     externalValidations: ExternalValidations;
     formData: ClientTaxDocumentation;

package/dist/src/wizard/RowInput/ShowHideInputRow/ShowHideInputRow.d.ts

@@ -3,10 +3,11 @@ import { ShowHideInputProps } from 'ui';
 
 type ShowHideInputRowProps = {
     label?: boolean;
+    aka?: string;
     subLabel?: boolean;
     onChange?: (val: string) => string;
     disabled?: boolean;
     children?: React.ReactNode;
 };
-export declare const ShowHideInputRow: ({ name, label, subLabel, onChange, disabled, children, }: ShowHideInputProps & ShowHideInputRowProps) => React.JSX.Element;
+export declare const ShowHideInputRow: ({ name, label, aka, subLabel, onChange, disabled, children, }: ShowHideInputProps & ShowHideInputRowProps) => React.JSX.Element;
 export {};

package/dist/src/wizard/RowInput/TinInputRow/TinInputRow.d.ts

@@ -0,0 +1,22 @@
+import { default as React } from 'react';
+import { TaxDocumentationKey } from 'types';
+
+export type TinInputProps = {
+    countryFieldKey: TaxDocumentationKey;
+    tinFieldKey: TaxDocumentationKey;
+    notRequiredFieldKey?: TaxDocumentationKey;
+    isIndividual: boolean;
+};
+export declare const AuTinInputRow: ({ name, disabled, aka, }: {
+    name: TaxDocumentationKey;
+    disabled?: boolean;
+    isIndividual?: boolean;
+    aka?: string;
+}) => React.JSX.Element;
+export declare const UsTinInputRow: ({ name, disabled, isIndividual, aka, }: {
+    name: TaxDocumentationKey;
+    disabled?: boolean;
+    isIndividual?: boolean;
+    aka?: string;
+}) => React.JSX.Element;
+export declare const TinInputRow: ({ countryFieldKey, tinFieldKey, notRequiredFieldKey, isIndividual, }: TinInputProps) => React.JSX.Element;

package/dist/src/wizard/RowInput/TinInputRow/index.d.ts

@@ -0,0 +1 @@
+export * from './TinInputRow';

package/dist/src/wizard/RowInput/VisibleRow/VisibleRow.d.ts

@@ -1,9 +1,10 @@
 import { default as React } from 'react';
 import { TaxDocumentationKey } from 'types';
 
-export declare const VisibleRow: ({ label, subLabel, badge, name, header, children, onEdit, }: {
+export declare const VisibleRow: ({ label, subLabel, badge, name, header, children, onEdit, aka, }: {
     badge?: boolean;
     label?: boolean;
+    aka?: string;
     subLabel?: boolean;
     header?: string;
     name: TaxDocumentationKey;

package/dist/src/wizard/RowInput/index.d.ts

@@ -8,4 +8,5 @@ export * from './SelectRow';
 export * from './ShowHideInputRow';
 export * from './TextAreaRow';
 export * from './TextInputRow';
+export * from './TinInputRow';
 export * from './ToggleButtonRow';