Limit Supported Languages
Limiting the use supported languages allows you to limit the languages in which transactions can be sent for signing. This means that you can have control over the branding and white labeling of those transactions.
The limit applies only to signing languages, and not to the sender UI languages.
It is strongly recommended that you turn on the Override Recipient's Preferred Language account feature when Limit Supported Languages is enabled. This setting can be found in Admin > Account Configuration > Feature Settings > General.
Enabling the feature
In order to use these feature, the following steps must be taken:
-
The feature Limit Supported Languages needs to be enabled for the account.
-
The list of supported languages needs to be defined.
-
A default signing language needs to be defined.
To enable Limiting Supported Languages:
-
Navigate to Admin > Account Configuration > Feature Settings >General.
-
Select Limit supported signing languages.
-
Navigate to Admin > Account Configuration > Supported Languages:
-
Select the list of languages to support
-
All OneSpan Sign supported languages are displayed
-
Language names are displayed in the language of the logged in user
-
-
Select the Default signing language. Only the languages selected above will be displayed.
Clicking Reset will remove all previous selections, meaning that there will be no supported languages selected.
For more information on the default behavior when configuring a Recipient, see Configuring Recipients.
Using APIs and SDKs
When adding a recipient to a transaction or template from the API/SDKs note the following:
-
For a Template or a Transaction that has never been sent, if the selected language is unsupported, the creation will fail with a message that reads "The recipient language is invalid. The language should be among <list of supported language codes>"
-
For a Transaction that has been previously sent, if the selected language is different from the transaction language AND is not part of the list of supported languages, the creation will fail with a message that reads "The recipient language is invalid. The language should be among <current transaction language if not in supported list>, <list of supported language codes>"
Language Precedence from the API/SDKs
When adding an external recipient using POST Packages or POST packages/{packageId}/roles, the following logic will be used to determine which language should be used:
| Signer Language in Payload | followTransactionLanguage Property in Payload | followTransactionLanguage value that will be set by OSS | Final Recipient Language |
|---|---|---|---|
| Specified | Not specified (property not added) | followTransactionLangauge: true | Use transaction language |
| Null | Not specified (property not added) | followTransactionLangauge: true | Use transaction language |
| Not specified (property not added) | Not specified (property not added) | followTransactionLangauge: true | Use transaction language |
| NO_LANG | Not specified (property not added) | followTransactionLangauge: true | Use transaction language |
| Empty | Not specified (property not added) | followTransactionLangauge: true | Use transaction language |
| Null | followTransactionLangauge: true | Use transaction language | |
| Empty | followTransactionLangauge: true | Use transaction language | |
| TRUE | followTransactionLangauge: true | Use transaction language | |
| FALSE | followTransactionLangauge: false | Default signing language | |
| Null | followTransactionLangauge: true | Use transaction language | |
| Empty | followTransactionLangauge: true | Use transaction language | |
| TRUE | followTransactionLangauge: true | Use transaction language | |
| FALSE | followTransactionLangauge: false | Default signing language | |
| Null | followTransactionLangauge: true | Use transaction language | |
| Empty | followTransactionLangauge: true | Use transaction language | |
| TRUE | followTransactionLangauge: true | Use transaction language | |
| FALSE | followTransactionLangauge: false | Default signing language | |
| Null | followTransactionLangauge: true | Use transaction language | |
| Empty | followTransactionLangauge: true | Use transaction language | |
| TRUE | followTransactionLangauge: true | Use transaction language | |
| FALSE | followTransactionLangauge: false | Default signing language | |
| Null | followTransactionLangauge: false | Specified language | |
| Empty | followTransactionLangauge: false | Specified language | |
| TRUE | followTransactionLangauge: true | Use transaction language | |
| FALSE | followTransactionLangauge: false | Specified language |