Skip to content

fix: use per-owner address country to determine proof-of-address requirement for beneficial owners#92389

Draft
aswin-s wants to merge 7 commits into
Expensify:mainfrom
aswin-s:fix/90494-beneficial-owner-address-country
Draft

fix: use per-owner address country to determine proof-of-address requirement for beneficial owners#92389
aswin-s wants to merge 7 commits into
Expensify:mainfrom
aswin-s:fix/90494-beneficial-owner-address-country

Conversation

@aswin-s
Copy link
Copy Markdown
Contributor

@aswin-s aswin-s commented Jun 2, 2026

Explanation of Change

The Documents page (proof-of-address upload) for beneficial owners in a GBP workspace was silently skipped when the owner's residential address country differed from the bank account country — for example, a GB-national with a US residential address on a GBP account.

Two defects fixed:

  1. getNeededDocumentsStatusForBeneficialOwner.ts — isProofOfAddressNeeded only triggered for EUR workspaces or when isCopyOfIDNeeded was true (GBP + non-GB nationality). It never checked whether the beneficial owner's address country differed from the bank account country. Added a fourth parameter beneficialOwnerAddressCountry and an isAddressCountryMismatch flag (scoped to GBP) that is folded into isProofOfAddressNeeded.

  2. BeneficialOwnerDetailsFormPages.tsx — The skip-pages predicate derived the owner's address country via a manually-constructed Onyx key. This is now sourced from getValuesForBeneficialOwner, the shared utility already used by sibling components, removing duplicated key construction across three files (BeneficialOwnerDetailsFormPages, Confirmation, Documents).

Fixed Issues

$ #90494
PROPOSAL: #90494 (comment)

Tests

  1. Go to a GBP workspace → Bank account setup → Beneficial owners.
  2. Add a beneficial owner with a non-GB residential address (e.g., United States).
  3. Verify the Documents page is shown and proof-of-address upload is required.
  4. Add a beneficial owner with a GB residential address.
  5. Verify the Documents page is skipped (proof-of-address not required for a matching address country).
  6. Add a beneficial owner with a non-GB nationality (e.g., US national) on a GBP account.
  7. Verify the Documents page is shown (existing isCopyOfIDNeeded path still works).
  8. Repeat steps 2–3 on a EUR workspace and verify proof-of-address is always required regardless of address country (existing EUR path unchanged).
  • Verify that no errors appear in the JS console

Offline tests

The beneficial owner form saves to Onyx draft — no online-only paths are affected. The address country value is read from the same draft key in all states.

QA Steps

  1. On staging, set up a GBP workspace with a bank account requiring beneficial owner details.
  2. Add a beneficial owner whose residential address country is different from the bank account country (e.g., US address on a GBP/UK account).
  3. Confirm the Documents step appears and proof-of-address upload is presented.
  4. Add a beneficial owner whose residential address country matches the bank account country (e.g., GB address on a GBP/UK account, non-GB nationality).
  5. Confirm the Documents step is skipped for proof-of-address (other document types such as proof-of-ownership still appear if required).
  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari

aswin-s added 7 commits June 2, 2026 22:22
@aswin-s
fix(beneficial-owner): use address country to determine proof-of-addr…
e50e26a 
…ess requirement

When a beneficial owner has UK citizenship but a non-UK residential
address (e.g. US), the Documents sub-step was incorrectly skipped
because the skip-pages predicate in BeneficialOwnerDetailsFormPages
only checked nationality, not residential address country.

Fixes two related defects:
1. BeneficialOwnerDetailsFormPages.tsx: tighten the GB skip condition
   to also require address country is GB (or unset). If the owner lives
   outside the UK, Documents must be shown regardless of citizenship.
2. getNeededDocumentsStatusForBeneficialOwner: add beneficialOwnerAddressCountry
   as a 4th param; set isProofOfAddressNeeded when address country ≠
   account country (address mismatch case).
3. Documents.tsx / Confirmation.tsx: read address country from draft
   and pass it to the utility function.

Fixes Expensify#90494
@aswin-s
fix(beneficial-owner): derive skip-pages from shared utility; scope a…
2a93a4d 
…ddress mismatch to GBP

- Replace inline DOCUMENTS skip condition with getNeededDocumentsStatusForBeneficialOwner
  so both the skip decision and document requirements stay in sync from a single source
- Scope isAddressCountryMismatch to GBP currency to match existing document requirement logic
@aswin-s
fix(beneficial-owner): make address-country mismatch check currency-a…
de4aba5 
…gnostic
@aswin-s
fix(beneficial-owner): address review comments — consistent country s…
00ea8ad 
…ource, guard comment, tests

- BeneficialOwnerDetailsFormPages: use country from getCurrencyForNonUSDBankAccount
  (includes achData fallback) instead of draft-only countryStepCountryValue
- Confirmation: read beneficialOwnerAddressCountry directly from draft key
  consistent with Documents.tsx instead of going through getValuesForBeneficialOwner
- getNeededDocumentsStatusForBeneficialOwner: add comment explaining the
  empty-string guard on accountCountry/beneficialOwnerAddressCountry
- Add unit tests for getNeededDocumentsStatusForBeneficialOwner covering
  all document flags and the new address-country mismatch parameter
@aswin-s
fix(beneficial-owner): scope address-country mismatch to GBP; remove …
6289bca 
…redundant Onyx subscription

- isAddressCountryMismatch now requires GBP currency, consistent with
  all other GBP-specific document requirements and the signer info analog
- BeneficialOwnerDetailsFormPages uses policyID prop directly for the
  policy lookup instead of subscribing to REIMBURSEMENT_ACCOUNT to
  re-derive it via achData.policyID
- Update test to assert CAD mismatch does not trigger proof of address
@aswin-s
refactor(beneficial-owner): use getValuesForBeneficialOwner to source…
58e527f 
… nationality and address country

Eliminates three parallel manual per-owner key derivations by reading
nationality and country from the shared utility that already centralises
this logic. Removes unused SafeString/NATIONALITY/COUNTRY imports from
Confirmation.tsx and Documents.tsx.
@aswin-s
style: rename shadowed validate parameter in Documents.tsx
219c0fe
@aswin-s aswin-s force-pushed the fix/90494-beneficial-owner-address-country branch from a346edc to 219c0fe Compare June 2, 2026 16:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@aswin-s aswin-s

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@aswin-s