OneSDK Quickstart Guide

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

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.

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.

Get OneSDK on your Web App

Our SDK supports two integration methods to fit your development workflow, using CDN and NPM.

Implementation with CDN

Implementation with NPM package

Use this method if you’re working with plain HTML/JavaScript or as a fallback if you’re having issues with NPM integration.

Just include the following script tag in your HTML file:

1   <html>
2     <head>
3       <script src="https://assets.frankiefinancial.io/one-sdk/v1/oneSdk.umd.js">
4       </script>
5     </head>
6   </html>