Skip to main content

Introduction

Welcome to the Spidify TypeScript SDK documentation.

The Spidify SDK is a modular, production-ready toolkit designed for integrating Spidify KYC (Know Your Customer) workflows into any JavaScript or TypeScript application.

It provides two main ways to integrate depending on your needs:

  1. Managed UI (SpidifySDK): An easy-to-use, iframe-based solution that injects the Spidify UI directly into your application. Perfect for getting started quickly.
  2. Headless Engine (KycSDK): A logic-only state machine that allows you to build your own completely custom UI while the SDK handles the complex backend orchestration.

Features​

  • Modular Design: Core, API, Step Engine, and UI layers separated cleanly.
  • State Management: Built-in state machine for robust step transitions.
  • Event-Driven: Comprehensive event system for host application integration.
  • Flexible UI: Supports both UI-managed and Headless modes.
  • Secure: Handles orchestration via short-lived session tokens.

Let's dive into getting you set up!