Skip to main content

SDK Integration

Zyphe exposes an HTTP SDK API under https://api.zyphe.com/sdk/.... You can call it with any HTTP client (Backend API integration) or with the npm packages below.

npm packages help TypeScript/JavaScript apps create sessions, embed the hosted UI, and verify webhooks. They are optional if you speak HTTP.

There is no native iOS or Android SDK. Mobile uses backend session creation + WebView: Mobile integration.

Before you install a package​

  1. Environment setup — api.zyphe.com vs verify.zyphe.com vs docs
  2. API keys — secret key for servers, publishable only for browser SDK
  3. Sandbox mode — isSandbox / sandbox query must match the session URL
  4. Hosted UI vs direct API — when not to reimplement capture

@zyphe-sdk/browser​

https://www.npmjs.com/package/@zyphe-sdk/browser

This package is designed for browser applications. It provides utilities to interact with the Zyphe platform, including verification session management and iframe embedding.

@zyphe-sdk/node​

https://www.npmjs.com/package/@zyphe-sdk/node

This package is designed for Node.js applications. It provides utilities to interact with the Zyphe platform, including webhook signature verification, verification session management, Export API helpers for flow results and document-verification details, on-demand AML screening, KYB case management (officers, document requests, decisions, the case report), and Transaction Monitoring ingestion. See the Node SDK guide.

React Native Integration​

For mobile applications, we provide a comprehensive integration guide using React Native with WebView. This approach works with both Expo and bare React Native projects. See the React Native Integration guide for detailed setup instructions, or the language-agnostic Mobile integration page.

@zyphe-sdk/core​

https://www.npmjs.com/package/@zyphe-sdk/core

This environment-agnostic package is used internally by both the sdk-node and sdk-browser packages. The exports are passed through to those packages, so you typically won't need to use this package directly. It can also be used on React Native backend servers (not inside the app binary with a secret key).

Direct HTTP (no package)​

Same create-session and step endpoints, documented as a single recipe:

→ Backend API integration · OpenAPI

Upgrading​

Moving to the KYB case helpers, or reading types from @zyphe-sdk/core/openapi? See the migration guide.

Theming​

You can match the verification flow to your brand using dashboard themes and per-session SDK overrides. See the Theming guide for the full list of color, border-radius, font, and logo options.