Workflow Configuration
To customize the identity verification workflow behavior.
userConsent
object
{ obtained: true obtainedAt: Date.now() }
No
Mandatory to pass this if skipIntroductionScreen & skipDocSelectionScreen both are set to true . Indicates that the user consent is obtained by the customer application.
documentType
string
Allowed values :
Malaysia
'MyKad' | 'MyKas' | 'MyPR' | 'MyTentera' | DRIVING_LICENSE|PASSPORT
Philippines
Philsys_ID | Multipurpose_ID | Professional_ID | Social_Security_ID | DRIVING_LICENSE | PASSPORT
Indonesia
KTP | DRIVING_LICENSE | PASSPORT
Thailand, Singapore, Vietnam
DRIVING_LICENSE | PASSPORT
No
Mandatory to pass if skipDocSelectionScreen is set to true. Indicated the type of document the user will use.
skipFaceMatch
boolean
No
Skips performing Face Match if set to true . Set this to true , if you want to perform only document verification.
docVerification.skipIntroductionScreen
boolean
No
Skips the introduction screen if set to true.
docVerification.skipDocSelectionScreen
boolean
No
Skips the document selection screen if set to true.
docVerification.skipTutorialScreen
boolean
No
Skips the doc capture tutorial screen if set to true.
docVerification.maxRetryAttempts
number
No
Maximum number of retry attempts for Document Verification BE API call , allowed. Default is 3.
docVerification.captureTimeOut
number
No
Timeout in milliseconds for document capture. Default is 120000 milliseconds. If user doesn’t capture within this, process will terminate.
docVerification.captureTimeOutCountdownDuration
number
No
Timeout in milliseconds for document capture countdown. If you pass 30000 countdown will be shown for last 30 seconds . Default is for last 20000 ms (20 seconds) - NEW
docVerification.hideDetectionTimeOutCountdownAlert
boolean
No
pass this true if countdown alert needs to be hidden . Default is false - NEW
docVerification.skipDocBackSideCapture
boolean
No
pass this true if you do not want document back side capture and verification. Back side is supported only for Malaysian Cards - MyKad, MyKas, MyPR, MyTentera
docVerification.hideDescriptions
object
hideDescriptions: { idvIntroduction: false, documentSelection: false, cameraAccess: false, documentCapture: true, documentPreview: false, },
No
If any of these not passed, by default description will be shown in all screens. Pass true to hide page description from the screen.
idvIntroduction - Introduction documentSelection - Document Selection cameraAccess - camera access screen documentCapture - Document capture screen
documentPreview - Document Preview screen
faceMatch.skipTutorialScreen
boolean
No
Skips the selfie capture tutorial screen if set to true.
faceMatch.cameraFrameShape
FRAME_SHAPE
No
Shape of the camera frame overlay. Possible values:"OVAL", "CIRCLE", "SQUARE" & "RECTANGLE" . Defaults to "OVAL"
faceMatch.maxRetryAttempts
number
No
Maximum number of retry attempts for Liveness + FaceMatch BE API call , allowed. Default is 3.
faceMatch.detectionTimeOut
number
No
Timeout in milliseconds for face detection. Default is 90000 milliseconds.
faceMatch.detectionTimeOutCountdownDuration
number
No
Timeout in milliseconds for face detection countdown. If you pass 30000 countdown will be shown for last 30 seconds . Default is for last 20000 ms (20 seconds)
faceMatch.hideDetectionTimeOutCountdownAlert
boolean
No
pass this true if countdown alert needs to be hidden . Default is false
faceMatch.skipDarkLightingScreenFlash
boolean
No
pass this true if you do not want the screen to flash white when dark area is detected.
faceMatch.hideStaticHeadShape
boolean
No
pass this true if you want to hide the static head shape inside the frame during selfie capture
faceMatch.hideDescriptions
object
hideDescriptions: { tutorial: false, cameraAccess: true, camera: true, selfieReview: false, }
No
If any of these not passed, by default description will be shown in all screens. Pass true to hide page description from the screen.
tutorial - Selfie capture tutorial screen cameraAccess - Camera access screen camera- Selfie capture screen
Last updated