Get started with Questionnaires

Create and manage questionnaires.

Questionnaires are usually filled in by applicants during verification. However, an operator who runs a video identification can also complete the questionnaire using the answers provided by the applicant.

A typical flow of working with questionnaires is as follows:

  1. You create a questionnaire and extend your verification level with a questionnaire step.
  2. Applicants pass verification in WebSDK or MobileSDK and answer your questions. Alternatively, an operator can complete the questionnaire on behalf of the applicant if needed.
  3. You review the submitted answers.
  4. You use the Workflow builder to assign an automated action to a specific answer if needed.

📘

Note

You can also collect files with the help of questionnaires. Sumsub only stores and does not processes the files. To retrieve the uploaded files, use the Dashboard or API.

Create questionnaire

Questionnaires consist of sections. Each section may contain one or more questions (items in API) and allows you to group them into different areas of application, depending on your scenario.

To create a questionnaire:

  1. In the Dashboard, go to the Questionnaires page and click Create a questionnaire.
  2. In Questionnaire settings, provide a questionnaire name which would be shown at the top-middle when applicants pass the questionnaire and enter an optional description.
  3. Check out the generated questionnaire ID and edit it if needed. The ID is used when working with API.
  4. Select the Allow team members to edit questionnaires checkbox to allow your team members to change questionnaires.
  5. Navigate to Questionnaire content to set up sections.

📘

Note

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

Set up questionnaire section

In Questionnaire content, you can group your questions into independent sections; each section per set of questions. You can add as many sections as you need, depending on your scenario.

To adjust a question section:

  1. Provide a section title that you want to be shown to your applicants. For example, you may want to group your questions into several sections in case you want to collect answers from different areas. This means that you can create several sections, each of them having different titles.
  2. In the Description field, enter an optional section description.
  3. In the ID field, review the automatically assigned identification number. You can use this number when specifying conditions or working via API.
  4. Via the switch button, identify if there will be a condition that defines the way how the data in each section should be displayed and processed. Such a condition might be based on answers to certain questions or whether the questions is answered at all. You can combine conditions by using logical operators, such as AND (&&) and OR (||). To refer to questions, use the Section id and Item id variables in the format sectionid.itemid.
  5. Go to the Question form to customize question details and add more questions to the section.
  6. To add another section, scroll down to the end of the page and click Add new section.

Add question

Specify question details. You can add as many questions as you need, depending on your scenario.

To specify questions:

  1. Provide a question title and enter an optional question description.
  2. In the ID field, review the automatically assigned identification number. You can use this number when specifying conditions or working via API.
  3. Select the Required checkbox if you want to mark the question as required. This way, your applicants will not be able to skip the question.
  4. From the Type of Question drop-down list, select a question type.
  5. Identify the text that will be shown in the placeholder.
  6. Adjust Advanced settings if you want to extend the default settings.
  7. Click Add option if you want to define custom values and configure risk scoring. Available only if Type of Question is Checkboxes, Multiple choice, or Dropdown.

Question types

Question types define the way the data should be collected. For example, if you want to receive some textual information from your applicants, you can select Short answer. If you want to give your applicants the ability to select from different options, you can opt for Checkboxes, Multiple choice, or Dropdown.

Available question types include:

TypeParameterDescription
Short answertextA simple text field.
ParagraphtextAreaAn expandable text area.
CheckboxesmultiSelectAn array of options. Creates check boxes.
Multiple choiceselectAn array of options. Creates radio buttons.
DropdownselectDropdownAn array of options. Creates a drop-down list.
Phone numberphoneA phone number field.
CountrycountrySelectA drop-down list with available countries.
Single file uploadfileAttachmentAllows uploading a file as an attachment.
Multiple file uploadmultiFileAttachmentsAllows uploading several files as an attachment.
DatedateA date field in format mm/dd/yyyy.
Date and timedateTimeA calendar control that allows you to select date and time.
Consent / AgreementboolA single checkbox.

Settings

Advanced settings let you set auxiliary parameters, such as logical conditions and formats.

OptionDescription
ConditionA logical condition that defines the way how the data in each section should be displayed and processed. Such a condition is based on the answers to certain question or whether the question is answered at all. You can combine conditions by using logical operators, such as AND (&&) and OR (||). To refer to questions, use the Section id and Item id variables in the format sectionid.itemid.
FormatThis drop-down list is available when Type of Question is set to Short answer, Paragraph, or Multiple file upload. Depending on which option is selected and while answering the questions, applicants must adhere to the format that you define here. For example, you can force your applicants to provide only numeric answers or answers that fall within the specified range using the minimum value and maximum value.

Options

Options let you configure risk scoring.

Available options include:

OptionDescription
ValueSets the value that you will get via the API after the applicant selects it.
TitleText description of the field shown to the user.
Risk scoreUpon completion of the questionnaire, the system simply sums up the number of points according to the applicant's answers. The way the received points are interpreted is decided independently, depending on your scenario. The risk score feature does not affect verification results.

Translate questionnaire

You can add translations of your questionnaire to use it while verifying applicants from different countries and regions. To do so, follow the simple steps:

  1. Create a questionnaire structure according to the settings described above. It should be done in English language mode.
  2. Navigate to the Questionnaire language drop-down list and select the language from the list.
  3. 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, you should switch back to English.
  • Fill in all the created fields (sections, questions, etc.) of your questionnaire before you start translating it to another language.

Add questionnaire to verification level

Each level consists of different check sequences (steps), depending on how you want your applicants to be verified. You can request applicants to complete a questionnaire as one of such steps.

To add a questionnaire to the verification level:

  1. Create a verification level.
  2. Add a Questionnaire step and specify the questionnaire that you want to use for the level.
  3. Save your changes.

Review answers

As soon as the applicant completes the questionnaire, all of the answers and uploaded files are added to their profile.

There are two ways of how to view the answers:

  • You can get the answers and files via this API method.
  • You can open the Applicants page and filter your applicants by the level name to which you assigned the questionnaire. Then select any applicant profile and open the Questionnaire section to see the submitted answers.

Use workflow builder

Apart from collecting the applicant data, you can use questionnaires in your verification flows to assign an automated action to a specific answer. Such actions may include adding specific tags or changing the applicant risk level.

For example, you can create a flow that adds a medium risk label to all unemployed applicants aged between 35 and 45:

  1. Create a questionnaire that requests applicants to provide their employment status.
  2. Create a respective applicant tag.
  3. Start building your flow and add the following condition: if Field: applicant.info.age -> greater than -> Value: 35 -> And -> Field: applicant.info.age -> less than -> Value: 45-> And -> Field: questionnaires.[your questionnaire name].[questionnaire section name].
  4. Proceed with setting up all the branches of your flow and publish it when done.

Manage questionnaires

Questionnaires are flexible; you can manage any of them in any of the following ways:

  • You can import and export a questionnaire as a JSON file.
  • You can change the existing questionnaire by altering its settings in a preferred way.
  • You can reset a questionnaire in case your applicants have already completed it and you want them to resubmit the answers. You can also reset a questionnaire by passing the questionnaire argument to this API method.
  • You can remove a questionnaire at any time in case you no longer need it.