Biometrics Web SDK
2.4.3
Search…
⌃K

Localization

Translation

The SDK provides the means to translate all text displayed on the UI. This is done by passing an object literal that acts as a dictionary lookup ({ [key: string]: string }) to the target component or JavaScript API instance. The property name is always translations and is an optional property on all components, as well as the Sybrin.Biometrics.Options instance passed to the JavaScript API.
The keys within the dictionary lookup are used to target specific text for translation, then the text is replaced with the provided value corresponding to the key.
Keys may be translation keys, or the exact source text that should be replaced.
The following table details all translations available in the Biometrics SDK:
Translation Key
Components
Description
Default/Source
sy-b-translation-1
Prepare
Prompt text with explanation regarding selfie
Your selfie will be encrypted and stored in our digital vault.
sy-b-translation-2
Prepare
Caption of the button that triggers the event to view privacy policy
View Our Privacy Policy
sy-b-translation-3
SelfieCapture
Caption of the button that cancels selfie capture and navigates back
Cancel
sy-b-translation-5
Prepare
Caption of the button that proceeds to the next step
Next
sy-b-translation-6
Prepare
Title displayed within the guidelines block
Selfie Guidelines
sy-b-translation-9
Prepare
Lighting conditions guideline
Ensure well-balanced lighting
sy-b-translation-10
Prepare
Accessories guideline
Remove hats, sunglasses and headsets
sy-b-translation-12
Prepare
Positioning guideline
Position face in frame
sy-b-translation-13
Prepare
Multiple faces guideline
Only one face must be in frame
sy-b-translation-15
DeviceSelect
Caption of the button that proceeds to the next step
Next
sy-b-translation-16
Passive
Caption of the button that cancels liveness and navigates back
Cancel
sy-b-translation-17
Result
Caption of the button that takes the user back for recapture
Retake
sy-b-translation-18
Result
Caption of the button that proceeds to the next step
Next
sy-b-translation-20
Result
Title attribute of the result image
Selfie
sy-b-translation-21
Passive,
SelfieCapture, JavaScript API
Text prompt to display when a selfie has successfully been taken and the user has to wait for processing to complete
Good job! Please wait...
sy-b-translation-22
Passive, SelfieCapture, JavaScript API
Text prompt to display with countdown when conditions are all correct and video recording has started (if enabled)
Perfect! Please hold still.
sy-b-translation-23
Passive, SelfieCapture, JavaScript API
Text prompt to display while liveness is initializing
Preparing...
sy-b-translation-24
Passive, SelfieCapture, JavaScript API
Text prompt to display when the user's face is not centered properly
Please center face
sy-b-translation-25
Passive, SelfieCapture, JavaScript API
Text prompt to display when the SDK is unable to detect the user's eyes
Please look at the camera
sy-b-translation-26
Passive, SelfieCapture, JavaScript API
Text prompt to display when the user's face is too far away from the camera
Please move closer to the camera
sy-b-translation-27
Passive, SelfieCapture, JavaScript API
Text prompt to display when the SDK is unable to detect a face
Scanning for face...
sy-b-translation-28
Passive, SelfieCapture, JavaScript API
Text prompt to display when more than one face is being detected
Please ensure only one face is visible in frame
sy-b-translation-29
Passive, SelfieCapture, JavaScript API
Text prompt to display when more light is needed
Lighting conditions too dark
sy-b-translation-30
Passive, SelfieCapture, JavaScript API
Text prompt to display when there is too much light
Lighting conditions too bright
sy-b-translation-31
Passive, SelfieCapture, JavaScript API
Text prompt to display when the image is not clear enough
Image too blurry
sy-b-translation-32
Passive, SelfieCapture, JavaScript API
Alert message to show if the SDK detects that the browser is not supported
Browser is not supported.
sy-b-translation-33
Passive, SelfieCapture, JavaScript API
Alert message to show if the SDK detects that the user is using a third party browser on an Apple device that doesn't allow camera access to third party browsers.
Browser is not supported. Please open in Safari.
sy-b-translation-34
Passive, SelfieCapture, JavaScript API
Alert message to show if video recording is enabled and the SDK detects that the browser does not support video recording
Video recording is not supported in this browser.
sy-b-translation-35
Passive, SelfieCapture, JavaScript API
Caption of the button that dismisses the alert window that is shown when a compatibility issue is detected
Ok
sy-b-translation-36
Prepare
Scan QR instruction that is displayed when the component is in mobile capture mode
Using your mobile device, please scan the above QR code or manually navigate to the following URL in your mobile browser:
sy-b-translation-37
Prepare
Additional instruction when the component is in mobile capture mode
The flow will continue after running selfie capture and clicking the "Complete Step" button on your mobile device
sy-b-translation-38
Prepare
Caption of the button that cancels mobile capture
Cancel
sy-b-translation-39
Prepare
Caption of the button that copies the mobile link to clipboard
Copy Link
sy-b-translation-40
Prepare
Caption of the button that starts mobile capture mode
Mobile Capture
sy-b-translation-41
Prepare
Caption of the button that proceeds to the liveness page
Take Selfie
sy-b-translation-42
Prepare
Text to temporarily change the copy button caption to once a link is copied
Copied!
sy-b-translation-43
Prepare
Text to temporarily change the copy button caption to once a link fails to copy
Failed to copy...
sy-b-translation-44
Result
Caption of the button that proceeds to the next step if the isSingleStep flag is set to true
Complete Step
sy-b-translation-45
Result
Caption of the button that skips liveness
Skip