Upgrade guide

Start at the version you're on and work up to the latest.

Start at the version you're on and work up to the latest. Each version lists what's new, then what you might need to change. Skip any change that doesn't match your setup.

You're onRead
6.26.3
6.0, 6.16.2, 6.3
5.x6.0, 6.2, 6.3
4.x5.0, 6.0, 6.2, 6.3
3.x4.0, 5.0, 6.0, 6.2, 6.3
npm install @taxbit/react-sdk@latest

Upgrading with an AI coding agent? The Taxbit React SDK skill works as an integration assistant in Claude Code, Cursor and other agents. It can review your existing integration, call out what each version changed, and apply the updates. Install it, then ask your agent to upgrade @taxbit/react-sdk to the latest version.

npx skills add taxbit-shared/taxbit-skills

6.3

What's new: optional e-delivery consent on W-forms; a taxbit-required class on required rows; a W-8 warning when the permanent residence address is a P.O. Box or c/o; a failed submission keeps the form and answers on screen so the user can retry.

What to change

  • E-delivery consent — to collect it, pass eDeliveryConsent. Without it, the form is unchanged and config.eDeliveryConsent is false.
  • Reading submissions — expect the optional boolean hasEDeliveryConsent. It's absent when the prop is off.
  • Phone numbers — accountHolder.phoneNumber is now E.164 (+447872615090, was 447872615090). If you expect digits only, strip the leading +. A country with no number no longer submits a phone.

6.2

What's new: usage telemetry; an invalid VAT number no longer blocks submission; Brazil's alphanumeric CNPJ is accepted.

What to change

  • Proxy allowlist — if you use proxyDomain and your proxy forwards only certain paths, add telemetry/events. Usage telemetry

6.1

What's new: 22 more jurisdictions in the country and phone pickers.

What to change: nothing.


6.0

What's new: WCAG 2.1 AA accessibility; color variables for theming; only the displayed language is downloaded; server-rendering support.

What to change

  • Custom CSS — Next now comes before Back in the HTML, busy buttons use aria-disabled, the required asterisk is a separate .taxbit-required-marker, and colors are --taxbit-color-* variables. If you style the step buttons, disabled buttons or the asterisk, check Customizing look and feel.
  • Automated tests — select fields by visible label and buttons by name, and check aria-disabled instead of disabled. Test your integration
  • Self-hosted files — if you copy the SDK to a CDN by hand instead of bundling it, copy every .js file in dist/. Install the SDK
  • Strict submission validation — if your backend rejects unknown fields, allow the new optional certification booleans.
  • Your page — set <html lang>, update the page <title> on each step with onProgress's stepTitle, and place the form where an <h4> heading fits. Meet accessibility requirements

5.0

What's new: FATCA collection for entity W-8s; GIIN checks; treaty claims tailored by income type.

What to change

  • treatyClaims — now requires typesOfIncome. Without it, the form won't start.
  • fatca={false} — remove it if typesOfIncome includes interest or dividends. Those payments require FATCA, and the form won't start.
  • useTaxbitStatus — now returns only the status. Use useTaxbit if you need the saved submission.
  • Reading submissions — expect schema_version: "5", FATCA fields on W-8s, and a config object.

4.0

What's new: TaxbitCuringDocumentation for clearing W-8 issues; needsCuringDocumentation and refresh methods on useTaxbit.

What to change

  • Custom CSS — three classes were renamed: taxbit-check-box → taxbit-checkbox, taxbit-checkBox-label → taxbit-checkbox-label, taxbit-section-title → taxbit-section-header-title. The Show/Hide button on masked fields moved, and sections and pages gained wrapper elements.

Full release notes are in CHANGELOG.md in the package.