The ID Verification Web SDK supports language customization. To implement internationalization, you can pass a configuration to the Initialize interface.
Overview
The ID Verification Web SDK supports multiple languages on both mobile (Mobile) and desktop (PC) devices.
To customize a language, you can create a configuration file and pass it to the LanguageConfig field in the Initialize interface.
If the LanguageConfig field is empty, the system automatically detects the language setting of the device. If the detection fails, the interface defaults to English.
Supported languages
The following languages are available only in the mobile (Mobile) integration mode.
The PC mode supports only Simplified Chinese, Traditional Chinese, and English. No other languages are supported.
Language | code | Notes |
Simplified Chinese | zh | Simplified Chinese |
Traditional Chinese | TW | Traditional Chinese |
English | en | English |
Malay | ms | Bahasa Melayu |
Indonesian | id | Bahasa Indonesia |
Thai | th | ภาษาไทย |
Vietnamese | vi | Tiếng Việt |
Japanese | ja | Japanese |
Korean | ko | 한국어 |
French | fr | Français |
Spanish | es | Español |
Portuguese | pt | Português |
Russian | ru | Русский |
Arabic | ar | العربية |
Configure the default language
To specify the default language, set the defaultLanguage field to the corresponding language code.
For example, to set the default language to English, you can configure the LanguageConfig field as follows:
{
"defaultLanguage": "en"
}Add a new language
Because ID Verification involves a large amount of text, adding new custom languages is no longer supported to prevent potential compatibility issues. This change does not affect custom languages that were added previously.
If your business requires a new language, you can submit a ticket or contact your business manager for support.
Language setting priority
The mobile version of the ID Verification Web SDK provides a language switch feature for end users. The language setting priorities are as follows:
If the language switch button is displayed: Language selected by the end user > defaultLanguage > System language (if supported by the product)
If the language switch button is hidden: defaultLanguage > System language (if supported by the product)
Language settings for the OCR result and editing page
The ID Verification certificate module provides an optional page to display and edit OCR results. This page contains two types of text: general operation text and native certificate fields. To ensure a consistent user experience, the following limitations apply:
General operation text: Refers to text on the recognition page, such as buttons and navigation elements.
Native certificate fields: Refers to fields recognized from the certificate, such as name, gender, address, and religion.
For the eKYC and ID_OCR solutions, multi-language settings on this page apply only to general operation text.
Native certificate fields support only Chinese, Traditional Chinese, and English.
If defaultLanguage is set to a language that is not supported for native certificate fields, the field names default to English.
For the eKYC_PRO solution, multi-language settings on this page apply only to general operation text.
Native certificate fields are displayed based on fixed rules.
Native certificate fields are displayed in a single language. The language that appears on the certificate takes priority.
If English is present on the certificate, the fields are displayed in English.