1.1.1

Localization

Localization can be configured by setting up language and translation files on the backend API. For each language you would like to add, you need:

  • A JSON file detailing the language metadata under Assets/Languages

  • An HTML file detailing your terms and conditions under Assets/Terms

  • An HTML file detailing your privacy policy under Assets/Privacy

  • An XLIFF file detailing translations under Assets/Translations

Language Metadata File

For each language that you want to support, there needs to be a metadata file in JSON format present under Assets/Languages in the backend API. Each metadata file must use an ISO 639-1 Standard Language Code, followed by the .json file extension. For example, if you would like to support English (United Kingdom), the file must be named en-gb.json.

Continuing to use UK English as an example, the file contents should be as follows:

{
  "Code": "en-gb",
  "DisplayName": "English (United Kingdom)",
  "Default": false,
  "FlowDirection" 0
}

The properties are:

  • Code: The ISO 639-1 Standard Language Code for the language

  • DisplayName: The user-readable display name for the language

  • Default: Whether or not the language should be considered to be the default one. To avoid unexpected behavior, ensure that only one language file has this property set to true.

  • FlowDirection: The direction in which the language flows. The options are:

    • 0: Line flow left to right. Page flow top to bottom

    • 1: Line flow right to left. Page flow top to bottom

Terms & Conditions File

For each language that you want to support, there needs to be a terms and conditions file in HTML format present under Assets/Terms in the backend API. Each file must use an ISO 639-1 Standard Language Code, followed by the .html file extension. For example, if you would like to support English (United Kingdom), the file must be named en-gb.html.

Privacy Policy File

For each language that you want to support, there needs to be a privacy policy file in HTML format present under Assets/Privacy in the backend API. Each file must use an ISO 639-1 Standard Language Code, followed by the .html file extension. For example, if you would like to support English (United Kingdom), the file must be named en-gb.html.

Language Translations File

For each language that you want to support, there needs to be a translations file in XLIFF format present under Assets/Translations in the backend API. Each translation file must use an ISO 639-1 Standard Language Code, followed by the .xliff file extension. For example, if you would like to support English (United Kingdom), the file must be named en-gb.xliff.

Translations

Please see the en-us.xliff translation file included with the backend API for an example and/or template for creating your own translations.

Translations in the XLIFF files are divided into:

  • Biometrics

  • Identity

  • Onboarding

The biometrics section specifically pertains to translations relating to liveness detection.

The identity section specifically pertains to translations relating to document ID capture and OCR.

The onboarding section covers everything else relating to the onboarding process.

Biometrics

Translation KeyStepsDescriptionDefault/Source

sy-b-translation-1

PassiveLiveness

Prompt text with explanation regarding selfie

Your selfie will be encrypted and stored in our digital vault.

sy-b-translation-2

PassiveLiveness

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

View Our Privacy Policy

sy-b-translation-3

PassiveLiveness

Prompt text above button to view guidelines

Take the perfect selfie.

sy-b-translation-4

PassiveLiveness

Caption of the button that shows guidelines

View Guidelines

sy-b-translation-5

PassiveLiveness

Caption of the button that proceeds to the next step

Next

sy-b-translation-6

PassiveLiveness

Title displayed within the guidelines page

Take selfie

sy-b-translation-7

PassiveLiveness

Subtitle displayed within the guidelines page

Guidelines to the perfect selfie

sy-b-translation-8

PassiveLiveness

Camera access guideline

Allow camera access when prompted

sy-b-translation-9

PassiveLiveness

Lighting conditions guideline

Ensure good lighting with no bright lights in background

sy-b-translation-10

PassiveLiveness

Accessories guideline

Remove hats, sunglasses and headsets

sy-b-translation-11

PassiveLiveness

Alignment guideline

Ensure correct alignment

sy-b-translation-12

PassiveLiveness

Positioning guideline

Position face in frame

sy-b-translation-13

PassiveLiveness

Multiple faces guideline

Only one face must be in frame

sy-b-translation-14

PassiveLiveness

Instructions guideline

Follow on-screen instructions

sy-b-translation-15

PassiveLiveness

Caption of the button that proceeds to the next step

Next

sy-b-translation-16

PassiveLiveness

Caption of the button that cancels liveness and navigates back

Cancel

sy-b-translation-17

AcceptPassiveLivenessResult

Caption of the button that takes the user back for recapture

Retake

sy-b-translation-18

AcceptPassiveLivenessResult

Caption of the button that proceeds to the next step

Next

sy-b-translation-19

PassiveLiveness

Title displayed in the tab of the guidelines window

Guidelines

sy-b-translation-20

AcceptPassiveLivenessResult

Title attribute of the result image

Selfie

sy-b-translation-21

PassiveLiveness

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

PassiveLiveness

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

PassiveLiveness

Text prompt to display while liveness is initializing

Preparing...

sy-b-translation-24

PassiveLiveness

Text prompt to display when the user's face is not centered properly

Please center face

sy-b-translation-25

PassiveLiveness

Text prompt to display when the SDK is unable to detect the user's eyes

Please open both eyes

sy-b-translation-26

PassiveLiveness

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

PassiveLiveness

Text prompt to display when the SDK is unable to detect a face

Scanning for face...

sy-b-translation-28

PassiveLiveness

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

PassiveLiveness

Text prompt to display when more light is needed

Lighting conditions too dark

sy-b-translation-30

PassiveLiveness

Text prompt to display when there is too much light

Lighting conditions too bright

sy-b-translation-31

PassiveLiveness

Text prompt to display when the image is not clear enough

Image too blurry

sy-b-translation-32

PassiveLiveness

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

Browser is not supported.

sy-b-translation-33

PassiveLiveness

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

PassiveLiveness

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

PassiveLiveness

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

Ok

Identity

Translation KeyStepsDescriptionDefault/Source

sy-i-translation-1

SelectDocumentType

Display name for passport

Passport

sy-i-translation-2

SelectDocumentType

Display name for identity card

Identity Card

sy-i-translation-3

SelectDocumentType

Display name for green book

Green Book

sy-i-translation-4

SelectDocumentType

Display name for driver's license

Driver's License

sy-i-translation-5

SelectDocumentType

Display name for seaman's book

Seaman's Book

sy-i-translation-6

SelectDocumentType

Display name for seaman's identity

Seaman's Identity

sy-i-translation-7

SelectDocumentType

Display name for postal ID

Postal ID

sy-i-translation-8

SelectDocumentType

Display name for social security

Social Security

sy-i-translation-9

SelectDocumentType

Display name for unified multi purpose ID

Unified Multi Purpose

sy-i-translation-10

SelectDocumentType

Display name for firearms license

Firearms License

sy-i-translation-11

SelectDocumentType

Display name for old professional regulations ID

PRC ID (Old)

sy-i-translation-12

SelectDocumentType

Display name for new professional regulations ID

New PRC ID

sy-i-translation-13

SelectDocumentType

Display name for integrated bar ID

Integrated Bar

sy-i-translation-14

SelectDocumentType

Display name for insurance card

Insurance Card

sy-i-translation-15

SelectDocumentType

Display name for health insurance card

Health Insurance Card

sy-i-translation-16

SelectDocumentType

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

Face photo page

sy-i-translation-17

SelectDocumentType

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

Front and back

sy-i-translation-18

SelectDocumentType

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

Front

sy-i-translation-19

SelectCountry

Display name for Ghana

Ghana

sy-i-translation-20

SelectCountry

Display name for Kenya

Kenya

sy-i-translation-21

SelectCountry

Display name for Malawi

Malawi

sy-i-translation-22

SelectCountry

Display for Mozambique

Mozambique

sy-i-translation-23

SelectCountry

Display name for Philippines

Philippines

sy-i-translation-24

SelectCountry

Display name for South Africa

South Africa

sy-i-translation-25

SelectCountry

Display name for Uganda

Uganda

sy-i-translation-26

SelectCountry

Display name for Zimbabwe

Zimbabwe

sy-i-translation-27

SelectCountry

Display name for other

Other

sy-i-translation-28

SelectCountry

Caption of the button that proceeds to the next step

Next

sy-i-translation-29

DataExtraction

Caption of the button that proceeds to the next step

Next

sy-i-translation-30

SelectDocumentType

Caption of the button that proceeds to the next step

Next

sy-i-translation-31

DataExtraction

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

DataExtraction

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

View Our Privacy Policy

sy-i-translation-33

DataExtraction

Prompt text above button to view guidelines

Take a good ID Document photo.

sy-i-translation-34

DataExtraction

Caption of the button that shows guidelines

View Guidelines

sy-i-translation-35

DataExtraction

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

DataExtraction

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

DataExtraction

Caption of the button that cancels mobile capture

Cancel

sy-i-translation-38

DataExtraction

Caption of the button that copies the mobile link to clipboard

Copy Link

sy-i-translation-39

DataExtraction

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

Copied!

sy-i-translation-40

DataExtraction

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

Failed to copy...

sy-i-translation-41

DataExtraction

Text prompt to display while document scan is initializing

Preparing...

sy-i-translation-42

DataExtraction

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

DataExtraction

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

DataExtraction

Text prompt to display when more light is needed

Lighting conditions too dark

sy-i-translation-45

DataExtraction

Text prompt to display when there is too much light

Lighting conditions too bright

sy-i-translation-46

DataExtraction

Text prompt to display when the image is not clear enough

Image too blurry

sy-i-translation-47

DataExtraction

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

Browser is not supported.

sy-i-translation-48

DataExtraction

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

DataExtraction

Title displayed in the tab of the guidelines window

Guidelines

sy-i-translation-50

DataExtraction

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

Upload Photo

sy-i-translation-51

DataExtraction

Caption of the button that starts mobile capture mode

Mobile Capture

sy-i-translation-52

DataExtraction

Caption of the button that proceeds to the document scan page

Take Photo

sy-i-translation-53

DataExtraction

Caption of the button that cancels document scan and navigates back

Cancel

sy-i-translation-54

DataExtraction

Title displayed within the guidelines page

Document Scan

sy-i-translation-55

DataExtraction

Subtitle displayed within the guidelines page

Take a photo

sy-i-translation-56

DataExtraction

Lighting conditions guideline

Ensure good lighting

sy-i-translation-57

DataExtraction

Alignment guideline

Ensure correct document alignment

sy-i-translation-58

DataExtraction

Background guideline

Try to avoid white surface background

sy-i-translation-59

AcceptDataExtractionResult

Caption of the button that steps back for recapture

Retry

sy-i-translation-60

AcceptDataExtractionResult

Caption of the button that proceeds to the next step

Next

sy-i-translation-61

AcceptDataExtractionResult

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

AcceptDataExtractionResult

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

AcceptDataExtractionResult

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

Complete Step

sy-i-translation-64

AcceptDataExtractionResult

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

Next

sy-i-translation-65

AcceptDataExtractionResult

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

AcceptDataExtractionResult

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

-- No Data --

sy-i-translation-67

AcceptDataExtractionResult

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

DataExtraction

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

Ok

sy-i-translation-69

AcceptDataExtractionResult

Heading to display above the front image

Front

sy-i-translation-70

AcceptDataExtractionResult

Heading to display above the back image

Back

Onboarding

Translation KeyStepsDescriptionDefault/Source

sy-o-translation-1

All

Heading displayed at the top of the onboarding process

Web Onboarding

sy-o-translation-2

Terms

Heading displayed above the camera request description

Permission to access your camera needed

sy-o-translation-3

Terms

Camera request description

You can complete your application quickly and easily using your device's camera to take a selfie. If you deny the permission request prompt, you will have to manually allow the permission in your browser settings.

sy-o-translation-4

Terms

Caption of button that grants camera access

Grant Camera Permission

sy-o-translation-5

Terms

Valid ID document requirement description, upper section

Valid ID

sy-o-translation-6

Terms

Valid ID document requirement description, lower section

Document

sy-o-translation-7

Terms

Mobile phone requirement description, upper section

Mobile

sy-o-translation-8

Terms

Mobile phone requirement description, lower section

Phone

sy-o-translation-9

Terms

Age requirement description, upper section

You must be

sy-o-translation-10

Terms

Age requirement description, lower section

16 years or older

sy-o-translation-11

Terms

Time requirement description, upper section

About 5 mins

sy-o-translation-12

Terms

Time requirement description, lower section

of your time

sy-o-translation-13

Terms

Caption of the terms of use button

By opening this account, you agree to Our Terms Of Use

sy-o-translation-14

Terms

Caption of the button that starts the onboarding process

Let's Begin

sy-o-translation-15

SubmitMobile

Text to prompt entry of mobile phone number for verification

Enter your phone number to receive a verification code.

sy-o-translation-16

SubmitMobile

Caption of button that shows the privacy policy

View Our Privacy Policy

sy-o-translation-17

SubmitMobile

Text above to prompt entry of mobile phone number for verification

Please enter your mobile number

sy-o-translation-18

SubmitMobile

Caption of button that initiates the sending of the verification code

Send verification code

sy-o-translation-19

VerifyOTP

Text to prompt verification code entry

Please enter your verification code

sy-o-translation-20

VerifyOTP

Caption of button that initiates the sending of a new verification code

Resend

sy-o-translation-21

VerifyOTP

Text prompt to query for code receival

Didn't receive a code?

sy-o-translation-22

VerifyOTP

Text of link that navigates back so that the user can enter a different number

Try a different phone number

sy-o-translation-23

AcceptPassiveLivenessResult

Caption of button that skips passive liveness

Skip

sy-o-translation-24

Finalize

Text that prompts the user to click the finalize button

Please click the submit button below to finalize onboarding

sy-o-translation-25

Finalize

Caption of button that initiates a retry process if onboarding failed

Retry

sy-o-translation-26

Finalize

Caption of button that completes the onboarding process

Complete

sy-o-translation-27

All

Error message to display if the web UI fails to connect to the backend API

Connection error

sy-o-translation-28

All

Prompt to display when a refresh is required

Please refresh

sy-o-translation-29

DataExtraction

Error message to display if mobile capture is interrupted by the primary session being closed

The primary session was closed

sy-o-translation-30

DataExtraction

Error message to display if mobile capture cannot start due to the session already being processed

This session is already being processed

sy-o-translation-31

Terms

Title of window that shows terms and conditions

Terms and Conditions

sy-o-translation-32

SubmitMobile, DataExtraction, PassiveLiveness

Title of window that shows privacy policy

Privacy Policy

sy-o-translation-33

Terms

Caption to display on camera permission button once permission has been granted

Camera Permission Granted

sy-o-translation-34

SubmitMobile

Validation error to display if the provided phone number is not valid

Not a valid phone number

sy-o-translation-35

SubmitMobile

Validation error to display if the provided phone number does not contain a valid country code

Invalid country code

sy-o-translation-36

SubmitMobile

Validation error to display if the provided phone number is too short

Too short

sy-o-translation-37

SubmitMobile

Validation error to display if the provided phone number is too long

Too long

sy-o-translation-38

SubmitMobile

Validation error to display if the provided phone number is not a number

Not a number

sy-o-translation-39

VerifyOTP

Text to prompt entering of verification code

Please enter your verification code

sy-o-translation-40

VerifyOTP

Error message to display if the provided verification code could not be verified

Code verification failed

sy-o-translation-41

VerifyOTP

Error message to display if the provided verification code was incorrect

Invalid code. Please try again

sy-o-translation-42

VerifyOTP

Text notification to display when a new verification code has been sent

A new code has been sent. Please enter your verification code

sy-o-translation-43

VerifyOTP

Prompt that shows how much time is left before another verification code can be sent

Resend available in

sy-o-translation-44

Dynamic

Validation error to indicate a required field

Required

sy-o-translation-45

Dynamic

Validation error to indicate an invalid value entered into a field

Invalid

sy-o-translation-46

Dynamic

Validation error to indicate an entered value being too short

Too short

sy-o-translation-47

Dynamic

Validation error to indicate an entered value being too long

Too long

sy-o-translation-48

Dynamic

Validation error to indicate that an entered value needs to be a whole number

Must be a whole number

sy-o-translation-49

Dynamic

Validation error to indicate that an entered value needs to be a number

Must be a number

sy-o-translation-50

Dynamic

Validation error to indicate that an entered value is too low

Too low

sy-o-translation-51

Dynamic

Validation error to indicate that an entered value is too high

Too high

sy-o-translation-52

AcceptDataExtractionResult

Final prompt to display when a partial step has been completed using mobile capture

Step Complete!

Please continue back in your desktop web browser.

sy-o-translation-53

Finalize

Text to display while onboarding is completing

Completing onboarding...

sy-o-translation-54

Finalize

Text to display once the onboarding process has completed in its totality

Thank you!

We will verify your KYC details within 5 days and get back to you if we have any problems.

sy-o-translation-55

Finalize

Text to display when the onboarding process fails to complete

Failed to complete. Please try again

sy-o-translation-56

All

Global prompt to display when something failed and the user should try again

Please try again

sy-o-translation-57

All

Global prompt to display when something failed and the user needs to start the process over

The process must be started over

sy-o-translation-58

All

Global prompt to display when something failed and the process cannot continue

The process cannot continue

sy-o-translation-59

All

Global prompt to display when something failed, but the flow can skip to the next step

Skipping to next step

sy-o-translation-60

Terms

Heading for terms step

KYC

sy-o-translation-61

Terms

Subheading for terms step

Before we get started, here's what you'll need.

sy-o-translation-62

AcceptAddressExtractionResult

Heading for address extraction result step

KYC

sy-o-translation-63

AcceptAddressExtractionResult

Subheading for address extraction result step

Please review the extracted address and confirm its correctness.

sy-o-translation-64

AddressExtraction

Heading for address extraction step

KYC

sy-o-translation-65

AddressExtraction

Subheading for address extraction step

It's time to capture your Living Address.

sy-o-translation-66

DataExtraction

Heading for data extraction step while in the prepare stage

KYC

sy-o-translation-67

DataExtraction

Subheading for data extraction step while in the prepare stage

Please prepare your identity document for capture.

sy-o-translation-68

DataExtraction

Heading for data extraction step while in the device selection stage

KYC

sy-o-translation-69

DataExtraction

Subheading for data extraction step while in the device selection stage

Please select a device to use for document capture.

sy-o-translation-70

DataExtraction

Heading for data extraction step while in the capture stage

KYC

sy-o-translation-71

DataExtraction

Subheading for data extraction step while in the capture stage

Please follow the instructions for document capture.

sy-o-translation-72

AcceptDataExtractionResult

Heading for data extraction result step

KYC

sy-o-translation-73

AcceptDataExtractionResult

Subheading for data extraction result step

We've already filled in some of your personal details. Please confirm they're correct.

sy-o-translation-74

Finalize

Heading for finalize step while in the processing stage

KYC

sy-o-translation-75

Finalize

Subheading for finalize step while in the processing stage

Almost done!

sy-o-translation-76

Finalize

Heading for finalize step once processing completes

KYC

sy-o-translation-77

Finalize

Subheading for finalize step once processing completes

All done!

sy-o-translation-78

Dynamic

Heading for dynamic step

KYC

sy-o-translation-79

Dynamic

Subheading for dynamic step

Please fill in all the required fields below

sy-o-translation-80

All

Heading for errors

KYC

sy-o-translation-81

All

Subheading for errors

An error occurred

sy-o-translation-82

AcceptPassiveLivenessResult

Heading for passive liveness result step once completed successfully

KYC

sy-o-translation-83

AcceptPassiveLivenessResult

Subheading for passive liveness result step once completed successfully

Well Done! We've successfully captured your selfie.

sy-o-translation-84

AcceptPassiveLivenessResult

Heading for passive liveness result step if an error occurs

KYC

sy-o-translation-85

AcceptPassiveLivenessResult

Subheading for passive liveness result step if an error occurs

Unfortunately, something went wrong. Please try again.

sy-o-translation-86

PassiveLiveness

Heading for passive liveness step while in the prepare stage

KYC

sy-o-translation-87

PassiveLiveness

Subheading for passive liveness step while in the prepare stage

It's time to take a selfie! Your selfie will become one of your unique identifiers and one of the methods the banks may use to authenticate in the future.

sy-o-translation-88

PassiveLiveness

Heading for passive liveness step while in the device selection stage

KYC

sy-o-translation-89

PassiveLiveness

Subheading for passive liveness step while in the device selection stage

Please select a device to use for liveness detection.

sy-o-translation-90

PassiveLiveness

Heading for passive liveness step while in the capture stage

KYC

sy-o-translation-91

PassiveLiveness

Subheading for passive liveness step while in the capture stage

Please follow the instructions for liveness detection.

sy-o-translation-92

AcceptDataExtractionResult

Heading for data extraction result step once completed successfully using mobile capture

KYC

sy-o-translation-93

AcceptDataExtractionResult

Subheading for data extraction result step once completed successfully using mobile capture

Step complete!

sy-o-translation-94

SelectCountry

Heading for country selection step

KYC

sy-o-translation-95

SelectCountry

Subheading for country selection step

It's time to capture your Identity Document.

sy-o-translation-96

SelectDocumentType

Heading for document type selection step

KYC

sy-o-translation-97

SelectDocumentType

Subheading for document type selection step

It's time to capture your Identity Document.

sy-o-translation-98

SubmitMobile

Heading for submit mobile step

KYC

sy-o-translation-99

SubmitMobile

Subheading for submit mobile step

Please verify your mobile number.

sy-o-translation-100

VerifyOTP

Heading for OTP verification step

KYC

sy-o-translation-101

VerifyOTP

Subheading for OTP verification step

Please verify your mobile number.

Last updated