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.Identity.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 Identity SDK:

Translation KeyComponentsDescriptionDefault/Source

sy-i-translation-1

DocumentSelect

Display name for passport

Passport

sy-i-translation-2

DocumentSelect

Display name for identity card

Identity Card

sy-i-translation-3

DocumentSelect

Display name for green book

Green Book

sy-i-translation-4

DocumentSelect

Display name for driver's license

Driver's License

sy-i-translation-5

DocumentSelect

Display name for seaman's book

Seaman's Book

sy-i-translation-6

DocumentSelect

Display name for seaman's identity

Seaman's Identity

sy-i-translation-7

DocumentSelect

Display name for postal ID

Postal ID

sy-i-translation-8

DocumentSelect

Display name for social security

Social Security

sy-i-translation-9

DocumentSelect

Display name for unified multi purpose ID

Unified Multi Purpose

sy-i-translation-10

DocumentSelect

Display name for firearms license

Firearms License

sy-i-translation-11

DocumentSelect

Display name for old professional regulations ID

PRC ID (Old)

sy-i-translation-12

DocumentSelect

Display name for new professional regulations ID

New PRC ID

sy-i-translation-13

DocumentSelect

Display name for integrated bar ID

Integrated Bar

sy-i-translation-14

DocumentSelect

Display name for insurance card

Insurance Card

sy-i-translation-15

DocumentSelect

Display name for health insurance card

Health Insurance Card

sy-i-translation-16

DocumentSelect

Subtitle prompt for documents that require the face photo page to be scanned

Face photo page

sy-i-translation-17

DocumentSelect

Subtitle prompt for documents that require front and back to be scanned

Front and back

sy-i-translation-18

DocumentSelect

Subtitle prompt for documents that require only the front to be scanned

Front

sy-i-translation-19

CountrySelect

Display name for Ghana

Ghana

sy-i-translation-20

CountrySelect

Display name for Kenya

Kenya

sy-i-translation-21

CountrySelect

Display name for Malawi

Malawi

sy-i-translation-22

CountrySelect

Display for Mozambique

Mozambique

sy-i-translation-23

CountrySelect

Display name for Philippines

Philippines

sy-i-translation-24

CountrySelect

Display name for South Africa

South Africa

sy-i-translation-25

CountrySelect

Display name for Uganda

Uganda

sy-i-translation-26

CountrySelect

Display name for Zimbabwe

Zimbabwe

sy-i-translation-27

CountrySelect

Display name for other

Other

sy-i-translation-28

CountrySelect

Caption of the button that proceeds to the next step

Next

sy-i-translation-29

DeviceSelect

Caption of the button that proceeds to the next step

Next

sy-i-translation-30

DocumentSelect

Caption of the button that proceeds to the next step

Next

sy-i-translation-31

Prepare

Prompt text with explanation regarding ID document photo

Your ID document photo will be encrypted and stored in our digital vault.

sy-i-translation-32

Prepare

Caption of the button that triggers the event to view privacy policy

View Our Privacy Policy

sy-i-translation-33

Prepare

Prompt text above button to view guidelines

Take a good ID Document photo.

sy-i-translation-34

Prepare

Caption of the button that shows guidelines

View Guidelines

sy-i-translation-35

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-i-translation-36

Prepare

Additional instruction when the component is in mobile capture mode

The flow will continue after running identity capture and clicking the "Complete Step" button on your mobile device

sy-i-translation-37

Prepare

Caption of the button that cancels mobile capture

Cancel

sy-i-translation-38

Prepare

Caption of the button that copies the mobile link to clipboard

Copy Link

sy-i-translation-39

Prepare

Text to temporarily change the copy button caption to once a link is copied

Copied!

sy-i-translation-40

Prepare

Text to temporarily change the copy button caption to once a link fails to copy

Failed to copy...

sy-i-translation-41

DocumentScan, JavaScript API

Text prompt to display while document scan is initializing

Preparing...

sy-i-translation-42

DocumentScan, JavaScript API

Text prompt to display when the SDK is looking for the front side of the ID document

Please hold the document up to the camera

sy-i-translation-43

DocumentScan, JavaScript API

Text prompt to display when the SDK is looking for the rear side of the ID document

Please flip the document over for rear photo

sy-i-translation-44

DocumentScan, JavaScript API

Text prompt to display when more light is needed

Lighting conditions too dark

sy-i-translation-45

DocumentScan, JavaScript API

Text prompt to display when there is too much light

Lighting conditions too bright

sy-i-translation-46

DocumentScan, JavaScript API

Text prompt to display when the image is not clear enough

Image too blurry

sy-i-translation-47

DocumentScan, JavaScript API

Alert message to show if the SDK detects that the browser is not supported

Browser is not supported.

sy-i-translation-48

DocumentScan, 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-i-translation-49

Prepare, JavaScript API

Title displayed in the tab of the guidelines window

Guidelines

sy-i-translation-50

Prepare

Caption of the button that launches the file picker for document photo upload

Upload Photo

sy-i-translation-51

Prepare

Caption of the button that starts mobile capture mode

Mobile Capture

sy-i-translation-52

Prepare

Caption of the button that proceeds to the document scan page

Take Photo

sy-i-translation-53

DocumentScan

Caption of the button that cancels document scan and navigates back

Cancel

sy-i-translation-54

Prepare, JavaScript API

Title displayed within the guidelines page

Document Scan

sy-i-translation-55

Prepare, JavaScript API

Subtitle displayed within the guidelines page

Take a photo

sy-i-translation-56

Prepare, JavaScript API

Lighting conditions guideline

Ensure good lighting

sy-i-translation-57

Prepare, JavaScript API

Alignment guideline

Ensure correct document alignment

sy-i-translation-58

Prepare, JavaScript API

Background guideline

Try to avoid white surface background

sy-i-translation-59

Result

Caption of the button that steps back for recapture

Retry

sy-i-translation-60

Result

Caption of the button that proceeds to the next step

Next

sy-i-translation-61

Result

Caption of the button that steps back for recapture with the mobile flag set to true after prompting for mobile capture

Yes

sy-i-translation-62

Result

Caption of the button that steps back for recapture with the mobile flag set to false after prompting for mobile capture

No

sy-i-translation-63

Result

Caption of the button that proceeds to the next step if the isSingleStep flag is set to true

Complete Step

sy-i-translation-64

Result

Caption of the button that proceeds to the next step if the isSingleStep flag is set to false

Next

sy-i-translation-65

Result

Error message to display when the provided result is an unsuccessful one

We were unable to extract data. Please try again.

sy-i-translation-66

Result

Placeholder text to display in a result field if there is no data for it

-- No Data --

sy-i-translation-67

Result

Prompt to display if the user clicks retry while on a desktop web browser if mobile capture is enabled

Looks like you're having trouble with the webcam. Would you like to try using mobile?

sy-i-translation-68

DocumentScan, JavaScript API

Caption of the button that dismisses the alert window that is shown when a compatibility issue is detected

Ok

sy-i-translation-69

Result

Heading to display above the front image

Front

sy-i-translation-70

Result

Heading to display above the back image

Back

Last updated