IDV Module
The IDV Module provides an all-in-one solution for implementing OCR and Biometrics in your application’s onboarding flow. It seamlessly integrates with vendor SDKs and automatically handles all necessary API calls between FrankieOne and vendor systems.
You may need to adjust your Content Security Policy (CSP) settings to allow the IDV module to function correctly. Refer to this page for more details.
Vendor Implementations
Onfido Integration
Incode Integration
Onfido provides a complete in-browser verification experience without requiring device switching.
Configuring Accepted Documents and Countries
Using Onfido, we can set document and country selection on document capture part of IDV. The customization options available all relate to the country and document type selection screen. By default, the selection screen is shown with the country selection being empty.
Depending on the customization options defined in this step, either the country or document type selection screens might not be shown:
- The country selection screen will not be shown if only 1 country is selected or if only passports are allowed
- The document selection screen will not be shown if only 1 document type is specified
Set Document & Country Selection
During the initialisation of OneSdk instance, you can specify accepted documents & countries.
documents
is an array of object, where:
Due to provider limitations, only one country can be specified in the `countries` array.
For example, if you attempt to set different countries for different document types like this:
Onfido will fallback to displaying the selection screen for the complete list of documents supported within the selection screens.
Event System
The IDV module uses an event-driven architecture to communicate state changes and results.
Core Events
Emitted when IDV is successfully mounted
Signals successful information detection
Result Events
The results event provides comprehensive verification outcomes, including document data and entity references.
Input Required Events
For Incode integrations, the ‘INTERRUPTED’ status typically indicates missing camera permissions.
Error Handling
For Incode integrations, refer to the Incode documentation for detailed error payload information.
Implementation Tips
- Always test the flow on both desktop and mobile devices
- Implement proper cleanup on component unmount
- Consider implementing retry logic for failed verifications
- Store the entityId for future reference