Reference

Changelog and versioning

Track API and webhook compatibility changes.

Versioning

Documentation is path-versioned under /docs/v1/.... The HTTP API currently uses /api/v1/....

Current version

  • Docs path version: v1
  • Web SDK: @zippykyc/web-sdk 2.0.1

Web SDK 2.0.1

Released 2026-07-22. Current package version.

  • Public README trimmed for npm (merchant-facing init options and API only).

Web SDK 2.0.0

Released 2026-07-22. Breaking changes for the embeddable modal SDK:

  • Public API is init, open, close, and version (removed on/off, show/hide, send, update, destroy).
  • Modal always mounts on document.body; container and modal options are removed.
  • Panel styling uses background (hex or rgb() / rgba()) and backgroundBlur; page overlay is a fixed dim.
  • Re-init() is rejected while a session is alive; allowed again only after verification completes.
  • close() or dismiss (X / overlay / Escape) calls onClose and keeps the session alive; onComplete runs after the SDK tears down the session.

Deprecation policy

Deprecated webhook events (inquiry.completed, inquiry.failed) remain listed for migration. New integrations should subscribe to preferred events only.