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

Identity

Onboarding

Last updated