OneSDK Quickstart Guide

Quick Integration Example

Note: The sample code below is just an example. Never generate tokens on the frontend — doing so can expose your credentials. Always generate tokens securely on your backend and pass them to your app as needed.

   import OneSDK from '@frankieone/one-sdk';
   
   const tokenResultRaw = await fetch(
     'https://backend.kycaml.uat.frankiefinancial.io/auth/v2/machine-session',
     {
       method: 'POST',
       headers: {  // Encode credentials as base64 for authorization header
         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 its ID here
           reference: "customer-reference",
           entityId: "abc-def-ghi"
         },
       }),
     }
   );
   
   // Initialize OneSDK with configuration
   const oneSdk = await OneSDK({ // Pass the auth token response
     session: tokenResultRaw,    // Set environment mode
     mode: "production",
     recipe: {
       ocr: {
         maxDocumentCount: 3,    // Allow up to 3 document scans
       }
     }
   });

Visit our npm package page for the latest version and detailed API documentation.

Quick Integration Example

   import OneSDK from '@frankieone/one-sdk';
   
   const tokenResultRaw = await fetch(
     'https://backend.kycaml.uat.frankiefinancial.io/auth/v2/machine-session',
     {
       method: 'POST',
       headers: {  // Encode credentials as base64 for authorization header
         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 its ID here
           reference: "customer-reference",
           entityId: "abc-def-ghi"
         },
       }),
     }
   );
   
   // Initialize OneSDK with configuration
   const oneSdk = await OneSDK({ // Pass the auth token response
     session: tokenResultRaw,    // Set environment mode
     mode: "production",
     recipe: {
       ocr: {
         maxDocumentCount: 3,    // Allow up to 3 document scans
       }
     }
   });

Visit our npm package page for the latest version and detailed API documentation.

Implementation Options

Hosted OneSDK

FrankieOne hosts and manages the SDK infrastructure for you.Perfect for:

Quick implementation
Minimal technical overhead
Teams focusing on core business logic

Embedded OneSDK

You host and manage the SDK within your infrastructure.Perfect for:

Complete flow customization
Deep integration requirements
Teams with strong technical resources

Detailed Comparison

Feature	Hosted OneSDK	Embedded OneSDK
Setup Complexity	Minimal	Advanced
Implementation Time	Days	Weeks
Flow Control	Limited	Complete
Customization	Basic	Extensive
Maintenance	Handled by FrankieOne	Self-managed
Cost	Additional fee	Base pricing
Infrastructure	Managed	Self-hosted

Technical Requirements

Frontend Knowledge

Modern JavaScript/TypeScript
Frontend frameworks (React, Vue, Angular)
NPM package management

Development Setup

Node.js 18+
Modern web browser
HTTPS for local development
TypeScript 5+ (If you’re using a web application framework)

Getting Started

Always use environment-specific credentials and never commit API keys to version control.

Obtain Your Credentials

Required Credentials

You’ll need the following for both UAT and Production:

    - Customer ID
    - API Keys

Don’t have credentials? Contact FrankieOne Support to get started.

Environment URLs

UAT: https://backend.kycaml.uat.frankiefinancial.io
PROD: https://backend.kycaml.frankiefinancial.io

Install the SDK

npm install @frankieone/one-sdk

yarn add @frankieone/one-sdk

⌘I

Quick Integration Example

Quick Integration Example

​Implementation Options

Hosted OneSDK

Embedded OneSDK

​Technical Requirements

Frontend Knowledge

Development Setup

​Getting Started

Implementation Options

Technical Requirements

Getting Started