OneSDK Quickstart Guide — FrankieOne

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

1 import OneSdk from '@frankieone/one-sdk'; 2 3 const tokenResultRaw = await fetch( 4 'https://backend.kycaml.uat.frankiefinancial.io/auth/v2/machine-session', 5 { 6 method: 'POST', 7 headers: { // Encode credentials as base64 for authorization header 8 authorization: 'machine ' + btoa(`${CUSTOMER_ID}:${API_KEY}`), 9 'Content-Type': 'application/json', 10 }, 11 body: JSON.stringify({ 12 permissions: { 13 preset: 'one-sdk', 14 // You can pass either your own unique customer reference 15 // or if entity already created/existed, you can pass its ID here 16 reference: "customer-reference", 17 entityId: "abc-def-ghi" 18 }, 19 }), 20 } 21 ); 22 23 // Initialize OneSDK with configuration 24 const oneSdk = await OneSdk({ // Pass the auth token response 25 session: tokenResultRaw, // Set environment mode 26 mode: "production", 27 recipe: { 28 ocr: { 29 maxDocumentCount: 3, // Allow up to 3 document scans 30 } 31 } 32 });