Configure Document Scan Structure

🧾Configure Document Scan Structure V1 / V3

📘 Overview

REL-ID’s IdvWebServer supports two different document scan data structures:

V1 (Default): Basic document data extraction.
V3 (Enhanced): Richer format with detailed field mappings, localization, and validation results.

The V3 structure is required for advanced document-specific validations and for enabling comprehensive identity verification flows.

⚙️ Steps to Enable V3 Scan Structure

To enable V3 document structure, perform the following steps in the GM Portal:

🔧 1. Login to GM Portal

🔧 2. Navigate to `Module Config Management`

🔧 3. Select the Module → `BlaZe-Adapter`

🔧 4. Search for the Config Key → `sdk.app.settings`

🔧 5. If the config is empty:

Paste the provided samplesdk.app.settings (see below)

🔧 6. If config already exists:

Change "version": "1.0" to "version": "3.0"

🔧 7. Click Save

🔁 8. Restart Modules:

BlaZe-Adapter
IdvWebServer

📦 Sample `sdk.app.settings` for V3

{
    "idv_sdk_app_config": {
        "nfcScanEnabled": true,
        "authenticityChecksEnabled": true,
        "hologramCheckEnabled": true,
        "saveDebugLogs": false,
        "saveCroppedImages": false,
        "nfcScanTimeOut": 45,
        "isRawDataRequired": false,
        "useDefaultDatabase": true,
        "timestamp": "1753938567624",
        "version": "3.0",
        "supportedVersions": ["3.0"],
        "imageQualityThresholds": {
            "dpiThreshold": 200,
            "imgMarginPart": 0.07,
            "angleThreshold": 8,
            "maxGlaringPart": 0.1,
            "brightnessThreshold": 80,
            "documentPositionIndent": 80
        },
        "imageQualityChecksConfig": {
            "focus": true,
            "glare": true,
            "bounds": true,
            "colorness": true,
            "occlusion": true,
            "brightness": true,
            "resolution": true,
            "perspective": true,
            "portraitPresence": true,
            "screenCapture": true
        },
        "authenticityChecksConfig": {
            "hologram": true,
            "dynaprint": true,
            "extendedMRZ": true,
            "extendedOCR": true,
            "securityText": true,
            "barcodeFormat": true,
            "geometryCheck": true,
            "imagePatterns": true,
            "photoEmbedding": true,
            "blackAndWhiteCopy": true,
            "multipleLaserImage": true,
            "portraitComparison": true,
            "opticallyVariableInk": true,
            "invisiblePersonalInfo": true,
            "electronicDeviceDetection": true
        }
    },
    "idv_sdk_docscan_config_v3": {
        "supported_document_types": {
            "11": {
                "*": {
                    "supported_and_mandatory_fields": {
                        "17": false
                    },
                    "lcid_preference": {
                        "*": [0]
                    }
                }
            },
            "12": {
                "*": {
                    "supported_and_mandatory_fields": {
                        "0": false,
                        "3": false,
                        "8": false,
                        "9": false
                    },
                    "lcid_preference": {
                        "*": [0]
                    }
                }
            },
            "17": {
                "*": {
                    "supported_and_mandatory_fields": {
                        "0": false,
                        "17": false
                    },
                    "lcid_preference": {
                        "*": [0]
                    }
                }
            },
            "49": {
                "*": {
                    "supported_and_mandatory_fields": {
                        "0": false,
                        "3": false,
                        "8": false,
                        "9": false,
                        "17": false,
                        "629": false
                    },
                    "lcid_preference": {
                        "*": [0]
                    }
                }
            },
            "215": {
                "*": {
                    "supported_and_mandatory_fields": {},
                    "lcid_preference": {
                        "*": [0]
                    }
                }
            },
            "224": {
                "*": {
                    "supported_and_mandatory_fields": {},
                    "lcid_preference": {
                        "*": [0]
                    }
                }
            }
        },
        "generic_supported_and_mandatory_fields": {
            "0": true,
            "2": true,
            "3": true,
            "4": false,
            "5": true,
            "7": false,
            "8": true,
            "9": true,
            "11": false,
            "12": false,
            "17": true,
            "25": true
        },
        "nfcConfig": {
            "enableNFCStatusScreen": false,
            "errorOnNfcTimedOut": true,
            "errorOnNfcBypass": true,
            "pkd_cert_url": "",
            "pkd_cert_checksum": ""
        },
        "isRawDataRequiredForKYC": false
    },
    "database_config": []
}

🧩 Note: Document types, fields, and LCID preferences can be expanded based on country and use case.

🔁 To Revert to V1 Structure

If you wish to switch back to V1:

Set "version": "1.0" in sdk.app.settings
Restart BlaZe-Adapter and IdvWebServer

⚠️ Notes

The sdk.app.settings configuration impacts both the IdvWebServer and REL-ID SDK (Mobile App).
Any changes made to this config are reflected in both environments.
Ensure changes are tested before deployment in production.

✅ Completion

V1/V3 configuration enables flexible control over document scan formats and processing capabilities. Use V3 for full-scale field validation, regional adaptations, and richer KYC integrations.

Updated 8 days ago