You can review the structure of any of your questionnaires using the Dashboard or Sumsub API:

When checking a newly created questionnaire to make sure it is properly designed and includes all the required information.
Before adding a questionnaire to the verification level and assigning it to the applicant.
To review the applicant answers along with the associated questions.

Review questionnaire in the Dashboard

To review questionnaires in the Dashboard:

Open the Questionnaires page.
Find and open the questionnaire that you need. Use search by the questionnaire name or ID, and adjust the filters as needed.
Review the questionnaire structure.

You can change most of the settings and modify questionnaires as needed.

To be able to modify questionnaires, your Dashboard account must be granted the Change applicant’s personal data permission.

Review questionnaire via API

To get the questionnaire structure via the API, use this method.

The response includes the following attributes:

Root variables (questionnaires attributes) — represent the questionnaire settings and core data items.
sections — objects containing section core data and question groups from the questionnaire.
items — objects representing single questions from the questionnaire.

To find the detailed response structure, possible content with descriptions, and response examples, refer to this article.

Examples of question types in API

Below, you can find the examples of possible question types. Each example represents an element from the API response in JSON format, and contains a brief description.

Section object

Each group of questions is included into an individual object in the sections array.

The following is an example of the section object.

{
   "id":"section1",
   "title":"Section 1",
   "localizedTitle":{
      "values":[
         {
            "lang":"en",
            "value":"Section 1"
         },
         {
            "lang":"de",
            "value":"Abschnitt 1"
         }
      ]
   },
   "desc":"Section 1 desription",
   "localizedDesc":{
      "values":[
         {
            "lang":"en",
            "value":"Section 1 desription"
         }
      ]
   },
   "condition":"",
   "showCondition":null,
   "items":[...],
   "delimiter":null
}

Delimiter

If you add a section separator to the questionnaire, the separator will be part of the API response structure presented in the specific form of a section with "id": null, "items": null, and null for any other fields except delimiter, which will be set to true.

{
   "id":null,
   "title":null,
   "localizedTitle":{
      "values":[
         {
            "lang":"en",
            "value":""
         }
      ]
   },
   "desc":null,
   "localizedDesc":{
      "values":[
         {
            "lang":"en",
            "value":""
         }
      ]
   },
   "condition":null,
   "showCondition":null,
   "items":null,
   "delimiter":true
}

`text` types

// Example of the basic `text` type of question.

{
   "id":"shortAnswerId",
   "title":"Short answer",
   "localizedTitle":{
      "values":[
         {
            "lang":"en",
            "value":"Short answer"
         }
      ]
   },
   "desc":"Question 1",
   "localizedDesc":{
      "values":[
         {
            "lang":"en",
            "value":"Question 1"
         }
      ]
   },
   "type":"text",
   "required":true,
   "format":null,
   "condition":null,
   "showCondition":null,
   "placeholder":"Type something",
   "localizedPlaceholder":{
      "values":[
         {
            "lang":"en",
            "value":"Type something"
         }
      ]
   },
   "options":null
}

// If you specify the specific format for the question, the `format` field will show it.

{
   "id":"shortAnswerWithFormat",
   "title":"Short answer with Email format",
   "localizedTitle":{
      "values":[
         {
            "lang":"en",
            "value":"Short answer with Email format"
         }
      ]
   },
   "desc":"Question 2",
   "localizedDesc":{
      "values":[
         {
            "lang":"en",
            "value":"Question 2"
         }
      ]
   },
   "type":"text",
   "required":true,
   "format":"email",
   "condition":null,
   "showCondition":null,
   "placeholder":"Type something",
   "localizedPlaceholder":{
      "values":[
         {
            "lang":"en",
            "value":"Type something"
         }
      ]
   },
   "options":null
}

// Example of the `textArea` type of question.
// Note, that if the field is not required (as in the example below), then "required" : null

{
   "id":"paragraphId",
   "title":"Paragraph",
   "localizedTitle":{
      "values":[
         {
            "lang":"en",
            "value":"Paragraph"
         }
      ]
   },
   "desc":"Question 6",
   "localizedDesc":{
      "values":[
         {
            "lang":"en",
            "value":"Question 6"
         }
      ]
   },
   "type":"textArea",
   "required":null,
   "format":null,
   "condition":null,
   "showCondition":null,
   "placeholder":"Type something",
   "localizedPlaceholder":{
      "values":[
         {
            "lang":"en",
            "value":"Type something"
         }
      ]
   },
   "options":null
}

`phone` type

// Example of the `phone` type of question.

{
   "id":"phoneNumberId",
   "title":"Phone number",
   "localizedTitle":{
      "values":[
         {
            "lang":"en",
            "value":"Phone number"
         }
      ]
   },
   "desc":"Question 4",
   "localizedDesc":{
      "values":[
         {
            "lang":"en",
            "value":"Question 4"
         }
      ]
   },
   "type":"phone",
   "required":true,
   "format":null,
   "condition":null,
   "showCondition":null,
   "placeholder":"XXXX XXXXXXX",
   "localizedPlaceholder":{
      "values":[
         {
            "lang":"en",
            "value":"XXXX XXXXXXX"
         }
      ]
   },
   "options":null
}

`date` types

// Example of the `date` type of question.

{
   "id":"dateId",
   "title":"Date",
   "localizedTitle":{
      "values":[
         {
            "lang":"en",
            "value":"Date"
         }
      ]
   },
   "desc":"Question 5",
   "localizedDesc":{
      "values":[
         {
            "lang":"en",
            "value":"Question 5"
         }
      ]
   },
   "type":"date",
   "required":true,
   "format":null,
   "condition":null,
   "showCondition":null,
   "placeholder":"dd.mm.yyyy",
   "localizedPlaceholder":{
      "values":[
         {
            "lang":"en",
            "value":"dd.mm.yyyy"
         }
      ]
   },
   "options":null
}

// Example of the `dateTime` type of question.

{
   "id":"dateAndTimeId",
   "title":"Date and time",
   "localizedTitle":{
      "values":[
         {
            "lang":"en",
            "value":"Date and time"
         }
      ]
   },
   "desc":"Question 7",
   "localizedDesc":{
      "values":[
         {
            "lang":"en",
            "value":"Question 7"
         }
      ]
   },
   "type":"dateTime",
   "required":null,
   "format":null,
   "condition":null,
   "showCondition":null,
   "placeholder":"dd.mm.yyyy, --:--",
   "localizedPlaceholder":{
      "values":[
         {
            "lang":"en",
            "value":"dd.mm.yyyy, --:--"
         }
      ]
   },
   "options":null
}

`select` types

The following are the question types to which the array of options is applicable.

// Example of the `select` type of question.

{
   "id":"multichoiceId",
   "title":"Multichoice",
   "localizedTitle":{
      "values":[
         {
            "lang":"en",
            "value":"Multichoice"
         }
      ]
   },
   "desc":"Question 10",
   "localizedDesc":{
      "values":[
         {
            "lang":"en",
            "value":"Question 10"
         }
      ]
   },
   "type":"select",
   "required":true,
   "format":null,
   "condition":null,
   "showCondition":null,
   "placeholder":"",
   "localizedPlaceholder":{
      "values":[
         {
            "lang":"en",
            "value":""
         }
      ]
   },
   "options":[
      {
         "value":"radio_option1Id",
         "title":"Option 1 radio",
         "localizedTitle":{
            "values":[
               {
                  "lang":"en",
                  "value":"Option 1 radio"
               }
            ]
         },
         "score":7.0
      },
      {
         "value":"radio_option2Id",
         "title":"Option 2 radio",
         "localizedTitle":{
            "values":[
               {
                  "lang":"en",
                  "value":"Option 2 radio"
               }
            ]
         },
         "score":14.0
      }
   ]
}

// Example of the `selectDropdown` type of question.

{
   "id":"dropdownId",
   "title":"Dropdown",
   "localizedTitle":{
      "values":[
         {
            "lang":"en",
            "value":"Dropdown"
         }
      ]
   },
   "desc":"Question 8",
   "localizedDesc":{
      "values":[
         {
            "lang":"en",
            "value":"Question 8"
         }
      ]
   },
   "type":"selectDropdown",
   "required":true,
   "format":null,
   "condition":null,
   "showCondition":null,
   "placeholder":"Type something",
   "localizedPlaceholder":{
      "values":[
         {
            "lang":"en",
            "value":"Type something"
         }
      ]
   },
   "options":[
      {
         "value":"drop_option1Id",
         "title":"Option 1 dropdown",
         "localizedTitle":{
            "values":[
               {
                  "lang":"en",
                  "value":"Option 1 dropdown"
               }
            ]
         },
         "score":5.0
      },
      {
         "value":"drop_option2Id",
         "title":"Option 2 dropdown",
         "localizedTitle":{
            "values":[
               {
                  "lang":"en",
                  "value":"Option 2 dropdown"
               }
            ]
         },
         "score":10.0
      }
   ]
}

// Example of the `multiSelect` type of question.

{
   "id":"checkboxesId",
   "title":"Checkboxes",
   "localizedTitle":{
      "values":[
         {
            "lang":"en",
            "value":"Checkboxes"
         }
      ]
   },
   "desc":"Question 9",
   "localizedDesc":{
      "values":[
         {
            "lang":"en",
            "value":"Question 9"
         }
      ]
   },
   "type":"multiSelect",
   "required":true,
   "format":null,
   "condition":null,
   "showCondition":null,
   "placeholder":"",
   "localizedPlaceholder":{
      "values":[
         {
            "lang":"en",
            "value":""
         }
      ]
   },
   "options":[
      {
         "value":"check_option1Id",
         "title":"Option 1 checkbox",
         "localizedTitle":{
            "values":[
               {
                  "lang":"en",
                  "value":"Option 1 checkbox"
               }
            ]
         },
         "score":6.0
      },
      {
         "value":"check_option2Id",
         "title":"Option 2 checkbox",
         "localizedTitle":{
            "values":[
               {
                  "lang":"en",
                  "value":"Option 2 checkbox"
               }
            ]
         },
         "score":12.0
      }
   ]
}

`bool` type

// Example of the `bool` type of question.

{
   "id":"consentId",
   "title":"Consent",
   "localizedTitle":{
      "values":[
         {
            "lang":"en",
            "value":"Consent"
         }
      ]
   },
   "desc":"Question 13",
   "localizedDesc":{
      "values":[
         {
            "lang":"en",
            "value":"Question 13"
         }
      ]
   },
   "type":"bool",
   "required":true,
   "format":null,
   "condition":null,
   "showCondition":null,
   "placeholder":"I agree",
   "localizedPlaceholder":{
      "values":[
         {
            "lang":"en",
            "value":"I agree"
         }
      ]
   },
   "options":null
}

`countrySelect` type

// Example of the `countrySelect` type of question.

{
   "id":"countryId",
   "title":"Country",
   "localizedTitle":{
      "values":[
         {
            "lang":"en",
            "value":"Country"
         }
      ]
   },
   "desc":"Question 3",
   "localizedDesc":{
      "values":[
         {
            "lang":"en",
            "value":"Question 3"
         }
      ]
   },
   "type":"countrySelect",
   "required":true,
   "format":null,
   "condition":null,
   "showCondition":null,
   "placeholder":"Select country",
   "localizedPlaceholder":{
      "values":[
         {
            "lang":"en",
            "value":"Select country"
         }
      ]
   },
   "options":null
}

// Example of the `countryMultiSelect` type of question.
// Several countries can be specified in this case.

{
  "id": "multipleCountriesId",
  "title": "Multiple Countries",
  "localizedTitle": {
    "values": [
      {
        "lang": "en",
        "value": "Multiple Countries"
      }
    ]
  },
  "desc": "Question 12",
  "localizedDesc": {
    "values": [
      {
        "lang": "en",
        "value": "Question 12"
      }
    ]
  },
  "type": "countryMultiSelect",
  "required": null,
  "format": null,
  "condition": null,
  "showCondition": null,
  "placeholder": "Select several countries",
  "localizedPlaceholder": {
    "values": [
      {
        "lang": "en",
        "value": "Select several countries"
      }
    ]
  },
  "options": null
}

`fileAttachment` types

// Example of the `fileAttachment` type of question.
// Note that there is no placeholder with the question, still you get the `placeholder` and `localizedPlaceholder` fields in the API response.

{
   "id":"fileUploadId",
   "title":"File upload",
   "localizedTitle":{
      "values":[
         {
            "lang":"en",
            "value":"File upload"
         }
      ]
   },
   "desc":"Question 11",
   "localizedDesc":{
      "values":[
         {
            "lang":"en",
            "value":"Question 11"
         }
      ]
   },
   "type":"fileAttachment",
   "required":true,
   "format":null,
   "condition":null,
   "showCondition":null,
   "placeholder":"",
   "localizedPlaceholder":{
      "values":[
         {
            "lang":"en",
            "value":""
         }
      ]
   },
   "options":null
}

// Example of the `multiFileAttachment` type of question.

{
   "id":"multiFileUploadId",
   "title":"Multi file upload",
   "localizedTitle":{
      "values":[
         {
            "lang":"en",
            "value":"Multi file upload"
         }
      ]
   },
   "desc":"Question 12",
   "localizedDesc":{
      "values":[
         {
            "lang":"en",
            "value":"Question 12"
         }
      ]
   },
   "type":"multiFileAttachments",
   "required":null,
   "format":"max_value:5",
   "condition":null,
   "showCondition":null,
   "placeholder":"",
   "localizedPlaceholder":{
      "values":[
         {
            "lang":"en",
            "value":""
         }
      ]
   },
   "options":null
}

Review questionnaire in the Dashboard

Review questionnaire via API

Examples of question types in API

Section object

Delimiter

text types

phone type

date types

select types

bool type

countrySelect type