Screen Configuration Reference
This section documents every screen in the KYC Web SDK and the configuration parameters available for each one. Use it as a reference when you need to customize copy, labels, and UI behavior. For example changing the introduction text, button labels, or step descriptions on document and selfie capture screens. For every screen, you’ll find the parameter name, type, whether it’s required, a description of what it controls, and the default value used by the SDK.
Introduction Screen
Introduction Screen - idvIntroduction - object​
title
string
No
The title displayed at the top of the introduction screen.
Verify Your Identity
description
string
No
A brief description displayed on the introduction screen.
We’ll guide you through a quick set of steps to verify your identity. The whole process usually takes 1–2 minutes.
stepsSubTitle
string
No
Sub title text displayed for the steps involved.
What to expect
docCaptureStepTitle
string
No
Document capture step title.
Document Capture
docCaptureStepDescription
string
No
Document capture step description.
Take a photo of your ID or passport
selfieCaptureStepTitle
string
No
Selfie capture step title.
Selfie Capture
selfieCaptureStepDescription
string
No
Selfie capture step description.
Verify your face matches your document
actionButton
string
No
Label for the button to proceed to the next step after reading the introduction.
Continue
Document Selection Screen
Document Selection Screen - documentSelection - object​​
​
title
string
No
The title displayed at the top of the document selection screen.
Document Selection
description
string
No
A brief description displayed on the document selection screen.
Take a photo of the original document so we can verify who you are
countryCardsSubTitle
string
No
Sub title displayed for the country specific cards selection
${country} Citizen
foreignCardsSubTitle
string
No
Sub title displayed for the foreign individual cards selection
Foreign Citizen
actionButton
string
No
Label for the button to proceed to the next step after document selection.
Continue
Document Capture Tutorial Screen
Document Capture Tutorial Screen - docTutorial - object
title
string
No
The title displayed at the top of the document tutorial screen.
Capture Your ${docType}
description
string
No
A brief description displayed on the document tutorial screen, guiding the user on how to capture the document image properly
Place your original ${docType} within the frame and follow the instructions below
instructions.idFitsFrame
string
No
Instruction text explaining to keep the ID inside the frame
Make sure your ID card fits inside the frame
instructions.idCardNotCropped
string
No
Instruction text explaining to make sure that ID card is not cropped
Ensure the ID card is fully visible and not cropped
instructions.avoidCoveringIdCard
string
No
Instruction text explaining to avoid covering the card with finger
Avoid covering the ID card with your finger
instructions.avoidLightReflection
string
No
Instruction text explaining to avoid light reflection on the card
Avoid light reflection on the ID card
instructions.avoidBlurriness
string
No
Instruction text explaining to avoid capturing a blurry image
Eliminate any blurriness to guarantee a sharp and clear photo
actionButton
string
No
Label for the button to proceed to the next step after reading the tutorial
Start Document Capture
Document Capture Screen
Document Capture Screen - docCapture - object
title
string
No
The title displayed at the top of the document capture screen.
Capture Your ${docType}
captureFrontSide
string
No
Instruction text explaining to capture the front side of the card
Capture the Front Side of ${docType}
captureBackSide
string
No
Instruction text explaining to capture the back side of the card
Capture the Back Side of ${docType}
docPreviewDescription
string
No
Description displayed during the preview of captured document.
Ensure the document is visible and easy to read
primaryActionButton
string
No
Primary action button after previewing the document - to continue the process
Continue
secondaryActionButton
string
No
Secondary action button after previewing the document - to retake the photo
Retake Photo
Selfie Capture Tutorial Screen
Selfie Capture Tutorial Screen - livenessTutorial - object
title
string
No
The title displayed at the top of the selfie tutorial screen.
Capture Your Selfie.
description
string
No
A brief description displayed on the selfie tutorial screen, guiding user how to capture a proper selfie.
Position your face within the frame.
instructions.holdPhoneSteady
string
No
Instruction text explaining to hold the device steady
Hold the phone steady using both hands
instructions.avoidGlasses
string
No
Instruction text explaining to avoid wearing glasses.
Don't wear glasses
instructions.avoidBrightPlace
string
No
Instruction text explaining to avoid being in bright place. ( for color flash case )
Avoid being in a very bright place
actionButton
string
No
Label for the button to proceed to the next step after reading the tutorial
Start Selfie Capture
title
string
No
The title displayed at the top of the selfie capture screen.
Capture Your Selfie.
description
string
No
A brief description displayed on the selfie capture screen.
Follow the instructions provided and ensure your face is clearly visible
detectionTimeOut
string
No
Custom label for detection timeout alert. ${time} will be replaced with actual time
${time} seconds left to complete your verification
helpText
string
No
Label for the help text below camera view.
Need help?
docCaptureTipsTitle
string
No
Title displayed for the help tips section.
Capture Your Selfie
noFaceDetected
string
No
Message shown when no face is detected in the camera frame.
Put your face in the frame
faceDetected
string
No
Message shown when a face is detected in the camera frame.
Stay still
placeFaceinFrame
string
No
Instruction to the user to position their face within the camera frame.
Put your face in the frame
multipleFaceDetected
string
No
Message shown when multiple faces are detected in the frame.
Ensure no additional faces are visible in the frame
faceTooFar
string
No
Message shown when the user's face is too far from the camera.
Move closer
faceNotStraight
string
No
Message shown when the user's face is not aligned properly.
Keep your face straight
faceToodark
string
No
Message shown when the user's face is in a dark environment.
Move to well-lit area
faceTooBright
string
No
Message shown when the user's face is in a brightly lit environment, causing overexposure.
Too bright
eyesClosed
string
No
Message shown when the user's eyes are closed, preventing accurate detection.
Open your eyes
Identity Verification Error Screen - idvError - object
title
string
No
The title displayed at the top of the error screen.
Verification Failed
errorSectionSubTitle
string
No
Sub title for the error section
We couldn’t complete your verification
docErrorLabel
string
No
Label below the document icon
Document Photo
selfieErrorLabel
string
No
Label below the document icon
Don't wear glasses
tipsSectionSubTitle
string
No
Sub title for the document/selfie capture tips section
Please retry & follow these tips
actionButton
string
No
Label for the action button
Retake Photo
unknownError
string
No
Message when unknown error occurs.
Oops! Something went wrong, please try again later
maxRetryExhausted
string
No
Message when maximum retries are exhausted.
You've reached the maximum number of attempts. Please try again later
backendError_5010
string
No
Message displayed when an backend error occurs with code 5010.
Invalid Card
backendError_5016
string
No
Message displayed when an backend error occurs with code 5016.
Invalid Card
backendError_5020
string
No
Message displayed when an backend error occurs with code 5020.
No card detected
backendError_5023
string
No
Message displayed when an backend error occurs with code 5023.
Bad quality image
backendError_5027
string
No
Message displayed when an backend error occurs with code 5027.
Front & Back side of the card not matching
backendError_5101
string
No
Message displayed when an backend error occurs with code 5101.
No card detected
backendError_5103
string
No
Message displayed when an backend error occurs with code 5103.
Bad quality image
backendError_5202
string
No
Message displayed when an backend error occurs with code 5202.
Blurry
backendError_5203
string
No
Message displayed when an backend error occurs with code 5203.
Too Dark
backendError_5204
string
No
Message displayed when an backend error occurs with code 5204.
Too Bright
backendError_5207
string
No
Message displayed when an backend error occurs with code 5207.
Glare
backendError_5402
string
No
Message displayed when an backend error occurs with code 5402.
Front & Back side of the card not matching
backendError_1041
string
No
Message displayed when an backend error occurs with code 1041.
Liveness verification failed
backendError_1051
string
No
Message displayed when an backend error occurs with code 1051.
Remove any obstructions from your face
backendError_1052
string
No
Message displayed when an backend error occurs with code 1052.
Move closer
backendError_1053
string
No
Message displayed when an backend error occurs with code 1053.
Please ensure the lighting is sufficient and the photo is clear
backendError_1054
string
No
Message displayed when an backend error occurs with code 1054.
Ensure no additional faces are visible in the frame
backendError_1055
string
No
Message displayed when an backend error occurs with code 1055.
Put your face in the frame
backendError_1058
string
No
Message displayed when an backend error occurs with code 1058.
Please ensure the lighting is sufficient and the photo is clear
backendError_1059
string
No
Message displayed when an backend error occurs with code 1059.
The selfie is blurry, hold your phone steady
backendError_1060
string
No
Message displayed when an backend error occurs with code 1060.
Keep your face straight
backendError_1062
string
No
Message displayed when an backend error occurs with code 1062.
Open your eyes
backendError_1063
string
No
Message displayed when an backend error occurs with code 1063.
Please ensure the lighting is sufficient and the photo is clear
backendError_1074
string
No
Message displayed when an backend error occurs with code 1074.
The selfie is too dark, ensure there's enough lighting for a clear photo
backendError_1075
string
No
Message displayed when an backend error occurs with code 1075.
The selfie is too bright, please adjust the lighting for a clear photo
backendError_1076
string
No
Message displayed when an backend error occurs with code 1076.
The selfie is blurry, hold your phone steady
Last updated