Translate questionnaire
Help applicants pass verification with questionnaires in their native tongue.
You can add custom translations to your questionnaires to verify applicants from different countries and regions in their native tongue.
Add questionnaire translation
To add translations:
- Create a new questionnaire, as described in this article. Must be done in English language mode.
- Navigate to the Questionnaire language drop-down list and select the language.
- Enter the translation text in a chosen language in fields. You can see the changes on the right shown in the preview.
Note
- To change the structure of your questionnaire, switch back to English.
- Fill in all the created fields (sections, questions, etc.) of your questionnaire before you start translating it to another language.
Get questionnaire translation via Dashboard
To get the translation of a questionnaire via the Dashboard:
-
In the Dashboard, go to the Questionnaires page and open a questionnaire of interest to see its structure. By default, the questionnaire is displayed in English.
-
In the preview area on the right, from the Questionnaire language drop-down list, select the language, in which you want to see the questionnaire.
You can see the translation both in the questionnaire structure and on the right, as shown in the preview.
Note
Translation in the selected language is only available if it has been previously added.
Get questionnaire translation via API
You can use the Get questionnaire information method to get the translation of the questionnaire elements.
Localization of each title, description, and placeholder is stored in the specific localization objects:
localizedTitle— contains the title localization values.localizedDesc— contains the description localization values.localizedPlaceholder— contains the placeholder localization values.
Each of these objects shares the same structure with each localization stored in the values array as an object. Every object in the array contains the following attributes:
| Attribute | Type | Description |
|---|---|---|
lang | String | Language in the ISO 639-1 alpha-2 code (en by default). |
value | String | Corresponding text in the specified language. Empty ("") if not provided. |
For clarity, see the examples below.
When you select a language in the questionnaire, the text to display in the interface will be taken from the corresponding object in the values array, if applicable. For example, if "lang": "de" exists, the value will be used for German.
Note
In case a relevant
langvalue with the desired language is not available, the text will be in English (by default), even if you select a different language.
Translation examples in API
In the following API response example, you can see that each title, desc, and placeholder field is accompanied by the localizedTitle, localizedDesc, and localizedPlaceholder objects, respectively.
Entire response example
{
"_id": "6717d0bc1696671999bc7a14",
"id": "questionnaireWithDeT",
"title": "Questionnaire with translation",
"localizedTitle": {
"values": [
{
"lang": "en",
"value": "Questionnaire with translation"
},
{
"lang": "de",
"value": "Fragebogen mit Übersetzung"
},
{
"lang": "pt",
"value": "Questionário com tradução"
}
]
},
"desc": "Example with multiple questionnaire languages",
"localizedDesc": {
"values": [
{
"lang": "en",
"value": "Example with multiple questionnaire languages"
},
{
"lang": "de",
"value": "Beispiel mit mehreren Fragebogen-Sprachen"
},
{
"lang": "pt",
"value": "Exemplo com vários idiomas de questionário"
}
]
},
"clientId": "aleksandr.khomutskii",
"modifiable": null,
"createdAt": "2024-10-22 16:20:12",
"sections": [
{
"id": "section1",
"title": "Section 1",
"localizedTitle": {
"values": [
{
"lang": "en",
"value": "Section 1"
},
{
"lang": "de",
"value": "Abschnitt 1"
},
{
"lang": "pt",
"value": "Seção 1"
}
]
},
"desc": "Section 1 description",
"localizedDesc": {
"values": [
{
"lang": "en",
"value": "Section 1 description"
},
{
"lang": "de",
"value": "Beschreibung von Abschnitt 1"
},
{
"lang": "pt",
"value": "Descrição da Seção 1"
}
]
},
"condition": null,
"showCondition": null,
"items": [
{
"id": "question1",
"title": "Question 1",
"localizedTitle": {
"values": [
{
"lang": "en",
"value": "Question 1"
},
{
"lang": "de",
"value": "Frage 1"
},
{
"lang": "pt",
"value": "Pergunta 1"
}
]
},
"desc": "Question 1 description",
"localizedDesc": {
"values": [
{
"lang": "en",
"value": "Question 1 description"
},
{
"lang": "de",
"value": "Beschreibung von Frage 1"
},
{
"lang": "pt",
"value": "Descrição da Pergunta 1"
}
]
},
"type": "text",
"required": null,
"format": null,
"condition": null,
"showCondition": null,
"placeholder": "Placeholder text",
"localizedPlaceholder": {
"values": [
{
"lang": "en",
"value": "Placeholder text"
},
{
"lang": "de",
"value": "Platzhaltertext"
},
{
"lang": "pt",
"value": "Texto de espaço reservado"
}
]
},
"options": null,
"arbitraryDocType": null
},
{
"id": "question2",
"title": "Question 2",
"localizedTitle": {
"values": [
{
"lang": "en",
"value": "Question 2"
},
{
"lang": "de",
"value": "Frage 2"
},
{
"lang": "pt",
"value": "Pergunta 2"
}
]
},
"desc": "Question 2 description",
"localizedDesc": {
"values": [
{
"lang": "en",
"value": "Question 2 description"
},
{
"lang": "de",
"value": "Beschreibung von Frage 2"
},
{
"lang": "pt",
"value": "Descrição da Pergunta 2"
}
]
},
"type": "multiSelect",
"required": null,
"format": null,
"condition": null,
"showCondition": null,
"placeholder": "",
"localizedPlaceholder": {
"values": [
{
"lang": "en",
"value": ""
}
]
},
"options": [
{
"value": "opt1",
"title": "Option 1",
"localizedTitle": {
"values": [
{
"lang": "en",
"value": "Option 1"
},
{
"lang": "de",
"value": "Wahl 1"
},
{
"lang": "pt",
"value": "Opção 1"
}
]
},
"score": 5.0
},
{
"value": "opt2",
"title": "Option 2",
"localizedTitle": {
"values": [
{
"lang": "en",
"value": "Option 2"
},
{
"lang": "de",
"value": "Wahl 2"
},
{
"lang": "pt",
"value": "Opção 2"
}
]
},
"score": 10.0
}
],
"arbitraryDocType": null
}
],
"delimiter": null
}
]
}
Note
By default, the
title,desc, andplaceholdervalues are in English, and match the"lang": "en"value of the corresponding object in thevaluesarray.
Examples of single objects
Below, you can see the examples of the localizedTitle, localizedDesc, and localizedPlaceholder objects in the API response.
"title": "Questionnaire with translation",
"localizedTitle":{
"values":[
{
"lang":"en",
"value":"Questionnaire with translation"
},
{
"lang":"de",
"value":"Fragebogen mit Übersetzung"
},
{
"lang":"pt",
"value":"Questionário com tradução"
}
]
}
"desc":"Section 1 description",
"localizedDesc":{
"values":[
{
"lang":"en",
"value":"Section 1 description"
},
{
"lang":"de",
"value":"Beschreibung von Abschnitt 1"
},
{
"lang":"pt",
"value":"Descrição da Seção 1"
}
]
}
"placeholder":"Placeholder text",
"localizedPlaceholder":{
"values":[
{
"lang":"en",
"value":"Placeholder text"
},
{
"lang":"de",
"value":"Platzhaltertext"
},
{
"lang":"pt",
"value":"Texto de espaço reservado"
}
]
}
Example of questions
In a questionnaire, localization objects can also be applied to questions containing the options array.
If this is the case, the only field that can be accompanied by localization is title. The localizedTitle provides a translation for each of the selected items. See the example below.
"options":[
{
"value":"opt1",
"title":"Option 1",
"localizedTitle":{
"values":[
{
"lang":"en",
"value":"Option 1"
},
{
"lang":"de",
"value":"Wahl 1"
},
{
"lang":"pt",
"value":"Opção 1"
}
]
},
"score":5.0
},
{
"value":"opt2",
"title":"Option 2",
"localizedTitle":{
"values":[
{
"lang":"en",
"value":"Option 2"
},
{
"lang":"de",
"value":"Wahl 2"
},
{
"lang":"pt",
"value":"Opção 2"
}
]
},
"score":10.0
}
]
Updated about 1 month ago