Wrapper Event Handlers
onCameraError - The function that is invoked when the camera is not available. The response value is an object with the error code and the message.
Sample Input Parameter
{
"name": "CameraError"
}
onChange - function which will be called after each step completes.
Sample Input Parameter
{
"step": {
"index": 2,
"img": "data:image/webp;base64,UklGRvLMCgBXRUJQVlA9fPasz...",
"blob": {
"size": 62714,
"type": "image/webp"
},
"type": "mrz",
"isAuto": false,
"source": "file",
"mrzText": "SVBVU0FDMTE3NzgyNDQ2PDwwNTwyNTxCMD..."
}
}
onError - The function that will be called when an error occurs. The response value is the object with the error code and the message
Sample Input Parameter
{
"name": "HttpError",
"statusCode": 404,
"header": "Server Side Problems",
"content": "Please try again later"
}
onMounted - the function that will be called on the component mounted. This function doesn't return a value.
onReset - function which will be called after reset all the steps button are clicked
Sample Input Parameter
{
"steps": [
{
"index": 1,
"img": null,
"type": "front",
"source": ""
},
{
"index": 2,
"img": null,
"type": "mrz",
"source": ""
},
{
"index": 3,
"img": null,
"type": "face",
"source": ""
}
],
"documentType": 2,
"metaData": {
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36",
"capturedMethod": "000",
"version": "2.5.9-beta",
"logs": {
"s": {
"2": 6580,
"3": 3861,
"5": 3460
}
}
}
}
onRetakeHook - function which will be called after the retake button is clicked
Sample Input Parameter
{
"step": {
"index": 2,
"img": "data:image/webp;base64,UklGRvLMCgBXRUJQVlA9fPasz...",
"blob": {
"size": 55732,
"type": "image/webp"
},
"type": "mrz",
"isAuto": false,
"source": "file",
"mrzText": "SVBVU0FDMTE3NzgyNDQ2PDwwNTwyNTxCMD..."
}
}
onValidate - The function that will be called after after the validation response received.
Sample Input Parameter
{
"applicantId": "7abac434-112a-4d37-2589-08780a67126a",
"attemptId": 22222,
"documentType": 1,
"document": {
"privateName": "TEST TEST",
"abbr3Country": "USA",
"abbrCountry": null,
"address": "TEST",
"city": "COLUMBUS",
"class": "D",
"country": "UNITED STATES OF AMERICA",
"dob": "1979-01-12",
"expires": "2024-01-12",
"eyes": "BLUE",
"familyName": "TEST",
"firstName": "TEST",
"fullName": "TEST TEST TEST",
"gender": "MALE",
"hair": "BLONDE",
"height": 80,
"id": "11111111",
"idType": "DL",
"issued": "2022-12-30",
"middleName": "TEST",
"postalBox": null,
"state": "OH",
"issuedBy": "OH",
"template": "09",
"weight": 149,
"zip": "51201-0000"
},
"attemptsCount": 5,
"attemptsLeft": 0,
"status": 0,
"validationStatus": {
"expired": false,
"documentIsValid": true,
"faceIsValid": true,
"antiSpoofingIsValid": true
},
"invalidDataErrors": [],
"faceSuccess": true,
"documentSuccess": true,
"documentHasNotExpired": true,
"hasRiskEvents": true,
"documentValidationTests": [
{
"displayName": "AddressValidation",
"name": "AddressValidation",
"status": 2,
"statusString": "Skipped",
"reason": "Integration was skipped by flow"
},
{
"displayName": "DMV",
"name": "DMVValidation",
"status": -1,
"statusString": "Disabled",
"reason": "Integration was turned off"
},
{
"displayName": "IdentiFraud",
"name": "IdentiFraudValidation",
"status": -1,
"statusString": "Disabled",
"reason": "Integration was turned off"
}
],
"callBackUrl": "https://idscan.net/?fromdvsonline&requestId=7ba5c4ce-112a-4d37-b3e9-08db0a6746f6"
}
onReloaded - The function that will be called after the component finishes reloading. This function doesn't return a value.
submit - function which will be called after clicking the submit button
Sample Input Parameter
{
"event":"filled",
"steps":[
{
"index":1,
"img":"data:image/webp;base64,UklGRoSvCA...",
"blob":{},
"type":"front",
"isAuto":false,
"source":"file"
},
{
"index":2,
"img":"data:image/webp;base64,UklGRtYUBwBXRUJ...",
"blob":{},
"type":"back",
"isAuto":false,
"source":"file",
"trackString":"QAoeDUFOU0kgNjM2MDI2MDgwMTAy..."
},
{
"index":3,
"img":"data:image/webp;base64,UklGRvoXCgBXRU...",
"blob":{},
"type":"face",
"isAuto":false,
"source":"file"
}
],
"documentType":1,
"metaData":"
{
\"userAgent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36\",
\"capturedMethod\":\"000\",
\"version\":\"2.10.1\",
\"logs\":{\"s\":{\"2\":9352,\"5\":9324,\"8\":18309}}
}
"}