New to embedded flows? Start with the Quick Start guide to get a working integration in minutes, then explore the flow guides below.
Choose a Flow
eKYC Flow
Full electronic Know Your Customer journey with manual form entry, document collection, and optional fraud detection via device tracking.
IDV Flow
Camera-based identity document verification powered by Incode. Minimal setup with automatic document capture and processing.
IDV with Review
IDV flow extended with an OCR review screen so users can verify extracted data before submission.
Split Flow (OCR + Biometrics)
Separate OCR and Biometrics components wired together with form screens for maximum control over the capture journey.
OCR Only
Document capture and data extraction without biometrics. Ideal when you only need to collect and verify document data.
Document Upload
File-based document collection using upload screens. Supports required and optional document types with review.
Flow Comparison
| Flow | Camera Capture | Biometrics | Manual Entry | Key Modules |
|---|---|---|---|---|
| eKYC | — | — | Yes | form |
| IDV | Yes | Yes | — | idv |
| IDV with Review | Yes | Yes | — | idv, form (REVIEW) |
| Split Flow | Yes | Yes | — | ocr, biometrics, form |
| OCR Only | Yes | — | — | ocr, form |
| Doc Upload | — | — | Yes | form (doc_upload type) |
Not Sure Which Flow to Use?
- Need camera-based document capture with facial matching? Use IDV or IDV with Review.
- Want full control over each capture step (OCR then biometrics)? Use Split Flow.
- Only need document data extraction, no biometrics? Use OCR Only.
- Collecting documents via file upload instead of camera? Use Doc Upload.
- Manual form-based KYC without camera capture? Use eKYC.
Prerequisites
Before starting any embedded flow, make sure you have:- API credentials — a Customer ID and API Key from the FrankieOne portal
- Backend token endpoint — a server-side endpoint that generates session tokens
- OneSDK loaded — either via the UMD script tag or the
@frankieone/one-sdknpm package