The Review Module provides review screens for your users to confirm you captured their information correctly.

The Review Module provides two distinct review screens:

  • Manual Flow Review: Allows users to review entered details before verification
  • OCR Review: Enables review and correction of OCR-extracted information

Manual Flow Review

Implementation Guide

1

Initialize the Component

1const manualReview = oneSdk.component('form', {
2 name: "REVIEW",
3 type: "manual"
4});
2

Mount the Component

1manualReview.mount("#form");
3

Add HTML Container

1<div id="form"></div>

Configuration Options

Event Handling

form:review:loaded
Emitted when Review screen initializes
form:review:partial

Triggers when some checks succeed but others fail

form:review:ready
Fires when submit button is clicked

OCR Review

Implementation Guide

1const idv = oneSdkInstance.flow('idv');
2const review = oneSdkInstance.component("form", {
3 name: "REVIEW",
4 type: "ocr"
5});
6
7idv.mount("#form");
8
9idv.on('results', () => {
10 review.mount("#form");
11});

Document Field Configuration

Configuration Structure

Document fields are configured per document type, with country-specific configurations available.

Document Configuration Example
1documents: [
2 {
3 type: 'DRIVERS_LICENCE',
4 countries: {
5 default: {
6 default: {
7 fields: [
8 {
9 fieldType: 'select',
10 name: 'region',
11 label: `Driver's Licence State/Territory`,
12 rules: {
13 required: {
14 value: true,
15 message: 'Please select a state/territory'
16 }
17 }
18 },
19 // Additional fields...
20 ]
21 }
22 }
23 }
24 }
25]

Field Configuration Reference

Built with