> ## Documentation Index
> Fetch the complete documentation index at: https://docs.frankieone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction to OneSDK

> OneSDK is a powerful client-side JavaScript library that simplifies customer onboarding by integrating FrankieOne’s KYC (Know Your Customer) and IDV (Identity Verification) services directly into your application.

## What is OneSDK?

OneSDK is FrankieOne’s client-side JavaScript SDK that enables fast, flexible, and secure integration of KYC and Identity Verification (IDV) services into your digital onboarding experience.

It allows you to embed verification workflows directly into your product — whether through a hosted page, an iFrame, or a fully embedded integration inside your own app.

OneSDK connects your frontend to FrankieOne’s orchestration platform, giving you access to a wide ranges of global verification vendors and data sources through a single, unified SDK and API.

## Why Choose OneSDK?

<CardGroup>
  <Card title="Fast Deployments with Pre-built Flows" icon="puzzle-piece">
    Pre-built templates, modular components, and straightforward APIs help you launch verification experiences quickly and reliably.
  </Card>

  <Card title="Unified Verification Layer for KYC and IDV" icon="building">
    Access multiple vendors through FrankieOne’s orchestration layer, enabling seamless identity checks across document, biometric, and AML workflows.
  </Card>

  <Card title="Vendor-Agnostic and Future-Proof" icon="rocket">
    Easily switch, mix, or expand vendors without refactoring your code, ensuring long-term flexibility as your business and regulatory needs evolve.
  </Card>

  <Card title="Built-in Compliance and Observability" icon="shield-check">
    Gain end-to-end visibility with detailed event logs, audit trails, and analytics — all designed to maintain compliance and monitor performance with confidence.
  </Card>
</CardGroup>

## Core Components

<Tabs>
  <Tab title="Modules">
    <CardGroup cols={3}>
      <Card title="Document Verification" icon="id-card">
        Capture and verify identity documents like passports, driver's licenses, and national ID cards.
      </Card>

      <Card title="Biometric Verification" icon="fingerprint">
        Implement face matching and liveness detection for enhanced security.
      </Card>

      <Card title="Fraud Detection" icon="shield-halved">
        Detect and prevent fraud through advanced risk assessment algorithms.
      </Card>
    </CardGroup>
  </Tab>

  <Tab title="Workflows">
    A OneSDK workflow is a carefully orchestrated sequence of modules that work together to verify a user comprehensively. This approach provides you with a unified view of the onboarded entity.
  </Tab>
</Tabs>

## When to Use OneSDK?

Use OneSDK whenever you want to deliver a smooth, compliant, and customisable verification experience without building vendor integrations or UI from scratch.

For most businesses, Pre-Built Hosted Flows are the recommended starting point — fast to deploy, fully managed, and easily customised through the FrankieOne Portal or API.

## How does OneSDK Work?

A OneSDK integration connects your client application to the FrankieOne API and multiple verification vendors in one seamless flow.

<Steps>
  <Step title="Initialize OneSDK">
    The user starts verification from your app or link.
  </Step>

  <Step title="Capture Data">
    OneSDK handles document capture, biometrics, and form input securely in the browser.
  </Step>

  <Step title="Orchestrate Verification">
    FrankieOne orchestrates verification across connected vendors.
  </Step>

  <Step title="Return Results">
    Results are returned to your system via API or webhook.
  </Step>
</Steps>

This approach simplifies integration while maintaining flexibility — you manage the experience, and FrankieOne manages the complexity of vendor connections.

## Integration Options

OneSDK supports a range of integration approaches depending on your technical capability and UX goals.

<Callout icon="thumbtack" iconType="regular" color="#1A6CFF">
  For most customers, Pre-built Hosted Flows are the fastest and most reliable way to go live — allowing you to start verifying customers in hours, not weeks.
</Callout>

| Category                   | Pre-Built Hosted Flows                                | Custom Hosted Flows                                  | Embedded Components                              | API-Only (No SDK)               |
| :------------------------- | :---------------------------------------------------- | :--------------------------------------------------- | :----------------------------------------------- | :------------------------------ |
| **Integration Effort**     | 🔵⚪️⚪️⚪️<br />No Code (Portal Only) / Single API Call | 🔵🔵⚪️⚪️<br />Some coding required                   | 🔵🔵🔵🔵<br />Most Coding (Frontend Development) | 🔵🔵🔵🔵<br />Highest           |
| **Branding Control**       | 🎨🎨<br />Logo, fonts and colours                     | 🎨🎨🎨<br />More customization                       | 🎨🎨🎨🎨<br />Extensive control                  | 🎨🎨🎨🎨<br />Extensive control |
| **Typical Time to Market** | 🚀 Within days                                        | 🚄 Usually 3-6 weeks                                 | 🚢 2 months+ subject to requirements             | Depending on requirements       |
| **Hosting**                | FrankieOne Hosted                                     | FrankieOne Hosted                                    | Your Site                                        | N/A                             |
| **Costs**                  | Monthly Hosting Fee                                   | Once-off Implementation Fee plus Monthly Hosting Fee | Once-off Implementation Fee                      | Refer to API Cost Models        |

As your requirements grow, you can easily evolve toward Custom Hosted or Embedded OneSDK integrations for deeper branding or in-app experiences.

## Best Practices

<Callout icon="star" iconType="regular" color="#3DD892">
  ##### Optimization Tips

  * Initialize OneSDK as early as possible in your app lifecycle.
  * Implement proper error handling for each verification step.
  * Use the testing environment for development and integration.
  * Monitor verification analytics to optimize your conversion rates.
</Callout>

<Callout icon="bell" iconType="regular" color="#FFCA16">
  ##### Important Considerations

  * Always handle user consent appropriately.
  * Implement proper session management.
  * Store sensitive data securely.
  * Follow data privacy regulations in your region.
</Callout>

## Next Steps

<CardGroup cols={3}>
  <Card title="Quick Start" icon="play" href="/docs/quickstart-guide">
    Get up and running with OneSDK in minutes.
  </Card>

  <Card title="API Reference" icon="book" href="/docs/reference/whats-new">
    Review detailed API documentation and examples.
  </Card>

  <Card title="Use Cases" icon="lightbulb" href="/docs/embedded-flows/overview">
    Explore common implementation scenarios.
  </Card>
</CardGroup>
