Skip to main content

Integration

This section is the operator path for connecting your product to Zyphe: hosts, keys, sandbox, HTTP session creation, mobile WebView, and media export.

It sits alongside:

GuideRole
SDK Integrationnpm packages (@zyphe-sdk/node, browser, React Native helpers)
WebhookReceiving and verifying result deliveries
API keysSecret vs publishable credentials (Dashboard)
Agents (MCP)AI-assisted flow and key setup

You do not need an npm package to integrate. The HTTP SDK API on https://api.zyphe.com is enough.

Start here​

  1. Environment setup — API vs verify vs docs hosts, .env template
  2. Sandbox mode — sandbox flag, URL path, mismatch behavior
  3. Backend API integration — create session → compose URL → open UI → webhook
  4. Check whether a user passed: look a user's status up by email or customData
  5. Mobile integration — no native SDK; WebView pattern
  6. Hosted UI vs direct API — when not to reimplement capture
  7. Export API: document images, full results, and the KYC report PDF (not in webhooks by default)
  8. Sandbox and go-live — checklist before production traffic

Decision shortcuts​

You are…Open…
Calling Zyphe from any backend languageBackend API integration
Building iOS / Android / React NativeMobile integration
On TypeScript and prefer packagesSDK Integration
Capturing documents in your own camera UIHosted UI vs direct API
Checking whether a user already passedCheck whether a user passed
Getting invalid_api_key or wrong-host errorsEnvironment setup · API keys

Product-level comparison of public link vs backend vs SDK vs MCP: Choosing an integration method.