IDV Module — FrankieOne

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

Country Selection

Users select their country of origin

Document Selection

Users choose their identification document type

Document Upload

Users capture or upload their chosen document

Biometrics Process

System prepares for biometric capture

Biometric Capture

Users complete their biometric verification

Onfido provides a complete in-browser verification experience without requiring device switching.

Event System

The IDV module uses an event-driven architecture to communicate state changes and results.

Core Events

ready

Emitted when IDV is successfully mounted

1 idv.on('ready', () => {
2   console.log('IDV component is ready');
3 });

detection_complete

Signals successful information detection

1 idv.on('detection_complete', () => {
2   setMounted(false); // Clean up
3 });

Result Events

1 idv.on('results', (checkStatus, document, entityId) => {
2   switch(checkStatus) {
3     case 'COMPLETE':
4       // Handle successful verification
5       break;
6     case 'FAILED':
7       // Handle failed verification
8       break;
9   }
10 });

The results event provides comprehensive verification outcomes, including document data and entity references.

Input Required Events

1 interface InputRequiredEvent {
2   information: {
3     entityId: string
4   },
5   checkStatus:
6     | 'AWAITING_DOCUMENT_UPLOAD_INVALID_TYPE'
7     | 'WAITING_DOC_UPLOAD'
8     | 'WAITING_SELFIE_UPLOAD'
9     | 'INCOMPLETE'
10     | 'INTERRUPTED'
11 }
12 
13 idv.on('input_required', (information, checkStatus) => {
14   switch(checkStatus) {
15     case 'WAITING_SELFIE_UPLOAD':
16       console.log("Awaiting selfie capture");
17       break;
18     case 'WAITING_DOC_UPLOAD':
19       console.log("Awaiting document upload");
20       break;
21     // Handle other states...
22   }
23 });

For Incode integrations, the ‘INTERRUPTED’ status typically indicates missing camera permissions.

Error Handling

1 interface ErrorEvent {
2   message: string;
3   payload: object;
4 }
5 
6 idv.on('error', (error) => {
7   console.error(`Error: ${error.message}`, error.payload);
8   // Implement your error handling logic
9 });

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

1	// Initialize the IDV flow
2	const idvFlow = oneSdk.flow("idv");
3
4	// Mount the IDV component to your HTML element
5	idvFlow.mount("#idv-component");

1	idv.on('ready', () => {
2	console.log('IDV component is ready');
3	});

1	idv.on('detection_complete', () => {
2	setMounted(false); // Clean up
3	});

1	idv.on('results', (checkStatus, document, entityId) => {
2	switch(checkStatus) {
3	case 'COMPLETE':
4	// Handle successful verification
5	break;
6	case 'FAILED':
7	// Handle failed verification
8	break;
9	}
10	});

1	interface InputRequiredEvent {
2	information: {
3	entityId: string
4	},
5	checkStatus:
6	\| 'AWAITING_DOCUMENT_UPLOAD_INVALID_TYPE'
7	\| 'WAITING_DOC_UPLOAD'
8	\| 'WAITING_SELFIE_UPLOAD'
9	\| 'INCOMPLETE'
10	\| 'INTERRUPTED'
11	}
12
13	idv.on('input_required', (information, checkStatus) => {
14	switch(checkStatus) {
15	case 'WAITING_SELFIE_UPLOAD':
16	console.log("Awaiting selfie capture");
17	break;
18	case 'WAITING_DOC_UPLOAD':
19	console.log("Awaiting document upload");
20	break;
21	// Handle other states...
22	}
23	});

1	interface ErrorEvent {
2	message: string;
3	payload: object;
4	}
5
6	idv.on('error', (error) => {
7	console.error(`Error: ${error.message}`, error.payload);
8	// Implement your error handling logic
9	});