New SDK Version 3.0.0

Release Details

Release Date: May 26, 2026

Summary

SDK Version 3.0.0

zerohash is upgrading its SDK to version 3.0.0, featuring a new architecture and a fully refreshed UI. All SDKs now share a unified look and feel, bringing cohesion across the entire suite. Platforms can also configure light and dark mode to match their product experience. For full details on the new UI and configuration options, see here.

To give platforms time to transition, we will continue supporting all versions up to and including 2.17.0 until August 31, after which they will be fully deprecated.

Timeline

  • Today: v3.0.0 is available on npm. v2.x is still fully supported.
  • Now through Aug 31, 2026: Both v2.x and v3.x are supported in parallel. Upgrade at your own pace.
  • Aug 31, 2026: v2.x is deprecated. Continued support is not guaranteed past this date.

How to upgrade

The public API is unchanged, so the upgrade is just a version bump in most cases.

1. Install v3:

npm install zh-web-sdk@3
# or
yarn add zh-web-sdk@3

2. (Optional) Set a theme:

The new SDKs support 'light', 'dark', and 'auto' themes. Default is 'light'.

const sdk = new ZeroHashSDK({
  zeroHashAppsURL: "https://web-sdk.zerohash.com",
  env: "prod",
  theme: "dark"   // 'light' | 'dark' | 'auto'
});

You can also change theme at runtime:

sdk.setTheme({ theme: "auto" });

3. Build and deploy.

No code changes required to your openModal, setJWT, or closeModal calls. The new UIs render automatically.

What stays the same

  • All AppIdentifier values (FUND, ONBOARDING, CRYPTO_BUY, etc.)
  • openModal, closeModal, setJWT, setFilters, isModalOpen
  • JWT acquisition and authentication flow
  • All postMessage events you listen for today (FUND_APP_LOADED, FUND_COMPLETED, FUND_FAILED, etc.). Same names, same payloads.

SDK's in scope

All SDK's are included in this upgrade. Listing out here for reference:

SDK permissionDescription
crypto-withdrawalsCrypto withdrawals
crypto-buyCrypto buy
crypto-sellCrypto sell
fiat depositsFiat deposits
fiat-withdrawalsFiat withdrawals
fiat-account-linkFiat - link account
crypto-account-linkCrypto- link account
crypto-payCrypto/stablecoin payins
crypto-payoutsCrypto/stablecoin payouts
onboardingKYC for end users/natural persons
fwcAccount Funding
participant-profileDisplay already-KYC'd user profile information
update-participantUpdate participant
recoveryRecovery (ie, funds sent on the wrong chain and users can withdraw)

Support and Resources

Please contact your dedicated Relationship Manager for questions about how to upgrade SDK's