Skip to main content

stream-connect-sdk docs

Reference for the 0.8 SDK. Start with the quickstart and the migration guide; reach for the rest as needed.

Getting started​

  • Quickstart: minimal HTML page that mounts the SDK, step-by-step (plus Android / iOS / React Native WebView patterns)
  • Migration: 0.7 to 0.8: what changed, what's deprecated, what stayed the same
  • Client Usage: full reference for every init option and lifecycle callback

Feature deep dives​

  • SDK Flow: the wizard step machine (choose-payer, enter-credentials, real-time validation, end widget)
  • Theme: theme.primaryColor and what it does (and doesn't) recolor
  • Two-Factor Authentication: inline MFA in the hero element, what state transitions look like, what can go wrong
  • Fix Credentials: the per-carrier status-badge view (entered automatically when connectAccessToken is supplied at init)
  • Patient Access API (Interop): carriers that authenticate via redirect to the carrier site instead of inline credentials
  • Headless mode: driving every step yourself with your own UI; using the stream-connect-sdk/headless bundle that ships without our stylesheet

Security​

  • Connect Access Token: server-side minting of connectAccessToken for fix-credentials and other advanced flows

Reference​

  • Errors: error messages grouped by where they originate in the SDK lifecycle (init, cred-submit, SSE, MFA)
  • FAQ

Other packages in this repo​

  • stream-connect-sdk-hook (v0.6.2, deprecated): a separate React Native / headless hook package on its own release line. Deprecated in favor of the WebView pattern documented in Quickstart > Mobile. The published 0.6.2 tarball keeps working for existing integrations; new ones should embed the main SDK in a WebView.