Localization: Adding a Custom Language Pack

The add_lang(lang_id, lang_obj) method allows adding a new or customized language pack.


  • lang_id: a string value that can be subsequently used as lang parameter for the open() method;

  • lang_obj: an object that includes identifiers of translation strings as keys and translation strings themselves as values.

A list of language identifiers:







Portuguese (Brazilian)



*Formerly pt, changed in 1.3.1.

An example of usage:

OzLiveness.add_lang('en', enTranslation), where enTranslation is a JSON object.

// Editing the button text
OzLiveness.add_lang('en', {
  action_photo_button: 'Take a photo'

To set the SDK language, when you launch the plugin, specify the language identifier in lang:

    lang: 'es', // the identifier of the needed language

You can check which locales are installed in Web SDK: use the ozLiveness.get_langs() method. If you have added a locale manually, it will also be shown.

A list of all language identifiers:

The keys oz_action_*_go refer to the appropriate gestures. oz_tutorial_camera_* – to the hints on how to enable camera in different browsers. Others refer to the hints for any gesture, info messages, or errors.

Since 1.5.0, if your language pack doesn't include a key, the message for this key will be shown in English.

Before 1.5.0

If your language pack doesn't include a key, the translation for this key won't be shown.

Last updated