> ## Documentation Index
> Fetch the complete documentation index at: https://docs.frankieone.com/llms.txt
> Use this file to discover all available pages before exploring further.
# OneSDK Implementation Guide
> From document verification to fraud prevention, OneSDK handles the complexity of multiple vendor integrations while providing a unified API surface
This guide provides a conceptual overview of OneSDK integration with basic code examples. The code snippets shown are illustrative and need to be adapted into your specific framework and application architecture.
For complete, working examples:
* See our Framework Integration Guides for Angular, React, Vue.js, Next.js and other frameworks
* Visit our [GitHub repository ](https://github.com/frankieone/frontend-onesdk-public-sample-codes) for extensive sample code and reference implementations
* Check out our Hosted Implementation Examples for end-to-end solutions hosted by FrankieOne
## Core Modules Overview
Complete KYC workflow for individual verification, including document handling, address verification, and profile management.
{" "}
Advanced biometric verification capabilities including facial recognition,
liveness detection, and matching.
{" "}
Intelligent document scanning and data extraction for IDs, passports, and
other verification documents.
{" "}
Comprehensive identity document verification with support for multiple
document types across jurisdictions.
{" "}
Customizable electronic Know Your Customer forms with built-in validation and
compliance checks.
Real-time fraud prevention and detection across multiple risk vectors.
## OneSDK Modules Data Capture Flow
## Quick Integration Guide
```bash theme={null}
npm install @frankieone/one-sdk
```
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.
```typescript theme={null}
import OneSdk from "@frankieone/one-sdk";
// fetch your token
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,
},
},
});
```
```typescript theme={null}
// Example: Initialize Individual and Biometrics modules
const individual = oneSdk.individual();
const biometrics = oneSdk.component("biometrics");
```
```typescript theme={null}
// Example: Mounting Biometrics Component
biometrics.mount("#bio-el");
biometrics.on("detection_complete", (event) => {
console.log("Biometric capture completed");
});
biometrics.on("results", (results) => {
console.log("Verification results:", results);
});
```
## Implementation Best Practices
```typescript theme={null}
try {
await individual.submit();
} catch (error) {
if (error.code === 'CONSENT_REQUIRED') {
// Handle missing consent
} else if (error.code === 'VALIDATION_ERROR') {
// Handle validation errors
}
}
```
```typescript theme={null}
// Example: Coordinated verification flow
const verifyUser = async () => {
// 1. Capture basic information
await individual.setProfileType('standard_kyc');
// 2. Perform document verification
const docResult = await idv.verifyDocument();
// 3. Run biometric checks
const bioResult = await biometrics.verifyFace();
// 4. Submit for final verification
return individual.submit();
};
```
Initialize modules only when needed and release resources after use. This is especially important for camera-based operations in the Biometrics and OCR modules.
## Common Integration Scenarios
```typescript theme={null}
const basicKyc = async () => {
const individual = oneSdk.individual();
const idv = oneSdk.idv();
await individual.addConsent('general');
await idv.captureDocument('PASSPORT');
return individual.submit();
};
```
```typescript theme={null}
const enhancedKyc = async () => {
const individual = oneSdk.individual();
const biometrics = oneSdk.biometrics();
const fraud = oneSdk.fraud();
await individual.setProfileType('enhanced');
await biometrics.performLivenessCheck();
await fraud.assess();
return individual.submit();
};
```
Each module can be used independently or as part of a comprehensive
verification flow. Check individual module documentation for detailed
implementation guidelines.
## Content Security Policy (CSP) Settings
You may need to adjust your Content Security Policy (CSP) settings to allow vendors' scripts and resources to load correctly. Below are the additional CSP rules required based on the vendor you are integrating with:
Refer to [https://documentation.onfido.com/sdk/sdk-csp-guide/#content-security-policy](https://documentation.onfido.com/sdk/sdk-csp-guide/#content-security-policy)
```plaintext title="Additional CSP rules for Incode" theme={null}
default-src 'self';
script-src 'report-sample' 'self' 'unsafe-inline' 'unsafe-eval' https://d3vv997wtl2myz.cloudfront.net https://*.incodesmile.com/ wasm-eval https://assets.frankiefinancial.io https://*.incode.com https://*.opentok.com;
style-src 'report-sample' 'self' 'unsafe-inline' https://fonts.googleapis.com;
object-src 'none';
base-uri 'self';
connect-src 'self' https://*.incodesmile.com https://*.i18nexus.com https://d3vv997wtl2myz.cloudfront.net https://featureassets.org https://prodregistryv2.org https://*.frankiefinancial.io https://*.opentok.com https://*.ipify.org data:;
font-src 'self' https://fonts.gstatic.com https://*.frankiefinancial.io data:;
frame-src 'self' https://incode.com https://*.incode.com https://*.incodesmile.com https://*.frankiefinancial.io https://*.frankie.one/;
img-src 'self' data: blob:;
manifest-src 'self';
media-src 'self';
worker-src 'self' blob:;
```
```plaintext title="Additional CSP rules for Truuth" theme={null}
script-src 'unsafe-inline' 'unsafe-eval' https://cdn.truuth.id https://assets.frankiefinancial.io;
connect-src https://static.au.truuth.id https://portal.api.au.truuth.id https://backend.latest.frankiefinancial.io data:;
img-src 'self' https://static.au.truuth.id data: blob:;
```
## Related Resources
Detailed API documentation for all OneSDK modules and methods.
{" "}
Guide for upgrading from previous versions of OneSDK.
{" "}
Sample implementations and integration patterns.
Technical support and implementation assistance.