OneSDK Quickstart Guide

OneSDK provides two implementation approaches to match your technical requirements and customization needs.

Quick Integration Example

A basic implementation of the OCR component

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   });

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

Technical Requirements

Frontend Knowledge

Frontend frameworks (React, Vue, Angular)
NPM

Dev Environment

Node.js 18+
TypeScript 5+

Getting Started

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

Obtain Your 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.

OneSDK CLI

Locally

Globally

Install

$ npm install @frankieone/one-sdk

Run the CLI!

Use npx

Use package.json scripts

$ npx onesdk-cli --generate --preview

On OneSDK CLI, you’ll be prompted with the following:

Select environment mode (dev, qa, uat, prod)
Enter credentials (Customer ID, [OPTIONAL] Customer Child ID, Api Key)
Select the flow
Generate the html code