Documentation

About OneSDK

Suggest Edits

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.

Why Choose OneSDK?

Flexible Integration

Mix and match verification modules to create custom onboarding flows that match your exact business needs.

Vendor Agnostic

Access multiple verification vendors through a single, unified API - switch or combine vendors without changing your code.

Quick Implementation

Drop-in components and clear APIs make integration straightforward, reducing time-to-market for your verification solutions.

Comprehensive Coverage

Get complete user verification through well-designed workflows that combine multiple verification methods.


Core Components

Modules

Document Verification

Capture and verify identity documents like passports, driver’s licenses, and national ID cards.

Biometric Verification

Implement face matching and liveness detection for enhanced security.

Fraud Detection

Detect and prevent fraud through advanced risk assessment algorithms.

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 entity being onboarded.


Implementation Guide

Basic setup

1. Install the SDK.

npm install @frankieone/one-sdk

2. Initialise.

import OneSDK from '@frankieone/one-sdk';

const tokenResultRaw = await fetch('https://backend.kycaml.uat.frankiefinancial.io/auth/v2/machine-session', {
  method: 'POST',
  headers: {
    authorization: 'machine ' + btoa(`${CUSTOMER_ID}:${API_KEY}`),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    permissions: {
      preset: 'one-sdk',
      // you can pass either your own unique customer reference
      // or if entity already created/existed, you can pass it's ID here
      reference: "customer-reference",
      entityId: "abc-def-ghi"
    },
  }),
});

const oneSdk = await OneSdk({
  session: tokenResultRaw,
  mode: "production",
  recipe: {
    ocr: {
      maxDocumentCount: 3,
    },
  }
});

Best Practices

✅

Optimisation Tips

  • Initialize OneSDK as early as possible in your application 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.

🔔

Important Consideration

  • Always handle user consent appropriately.
  • Implement proper session management.
  • Store sensitive data securely.
    Follow data privacy regulations in your region.

Updated 24 days ago

What’s Next