Get questionnaire information

Overview

Use this method to get the information about the questionnaire.

Request example

curl -X GET \
  'https://api.sumsub.com/resources/questionnaires/-;id=testQuestionnaire/one'

Response explained

The response is a JSON file that shows structured information about the questionnaire.

Below, you can find the response structure, possible content with descriptions, and response examples:

questionnaires attributes

The following table describes the questionnaire core data items.

FieldTypeDescription
_idStringUnique technical identifier of the questionnaire. Used for specific questionnaire-linked scenarios in the Dashboard, such as logs.
idStringUnique entity identifier of the questionnaire. Used for most questionnaire-linked scenarios in the Dashboard. Empty ("") if not selected.
titleStringQuestionnaire name. Empty ("") if not provided.
localizedTitleObjectIncludes an array of the title localization values.
descStringQuestionnaire description. Empty ("") if not provided.
localizedDescObjectIncludes an array of the description localization values.
clientIdStringUnique identifier of you as the Sumsub client.
modifiableBooleanOption to allow team members to edit questionnaire responses from the applicant page:
  • true — edit allowed.
  • false — edit not allowed.
  • null — if not selected.
createdAtDateDate and time when the questionnaire was created in the yyyy-mm-dd HH:MM:SS format.
sectionsArray of objectsIncludes the objects that represent a separate group of questions added to the questionnaire.

sections element fields

The following table describes the sections element fields — objects containing section core data and questions from the questionnaire.

FieldTypeDescription
idStringUnique section identifier.
titleStringSection title. Empty ("") if not provided.
localizedTitleObjectIncludes an array of the title localization values.
descStringSection description. Empty ("") if not provided.
localizedDescObjectIncludes an array of the description localization values.
conditionStringCondition that makes a section visible, depending on the value of the specified sectionId.itemId={options.value}. null if not selected.
showConditionBooleanOption to apply the condition to the section (true), or not (false). null if not selected.
itemsArray of objectsIncludes the objects that stand for a single question added to the questionnaire, and has an ID—item identifier—representing this question.
delimiterBooleanIndicates if this section is a separator (true) or not (false). null if not specified.

items element fields

The following table describes the items attributes – single questions from the questionnaire.

FieldTypeDescriptionSupported values
idStringUnique item identification number.Any unique identifier.
titleStringData field title. Empty ("") if not provided.Any string value.
localizedTitleObjectIncludes an array of the title localization values.{ "values": [ { "lang": "en", "value": "Title text" } ] }
descStringData field description. Empty ("") if not provided.Any string value.
localizedDescObjectIncludes an array of the description localization values.{ "values": [ { "lang": "en", "value": "Description text" } ] }
typeStringData field type.See Supported types of items for details.
requiredBooleanSets the data field as mandatory to fill. false if not provided.true or false.
formatStringFormat of the data field with validation. null if not provided.min:3, max:9 (sets min/max amount of symbols), email, etc.
conditionStringCondition that makes the item show up. null if not selected.sectionId.itemId={options.value} ( Example: 1-Section.1-2=someValue)
showConditionBooleanOption to apply condition to the section. null if not selected.true or false.
placeholderStringPlaceholder for the text data field. Empty ("") if not provided.Any string value.
localizedPlaceholderObjectIncludes the array of the placeholder localization values.{ "values": [ { "lang": "en", "value": "Type something" } ] }
optionsArray of objectsArray of values to select from. Only applicable to the select, selectDropdown, and multiSelect types. null for any other type.[ { "value": "someValue", "title": "Yes", "score": 0 } ]

Supported types of items

The following table describes the supported types of items.

ValueDescription
textText field.
textAreaExpandable text area.
phoneField with the phone number.
dateDate field.

dd.mm.yyyy. format for WebSDK and SDK UI, and yyyy-mm-dd — for API response.
dateTimeShows the calendar with the date and time fields.

dd.mm.yyyy., HH:MM format for WebSDK and SDK UI, and yyyy-mm-ddTHH:MM — for API response.
boolSingle checkbox.
selectArray of options. Creates radio buttons.
selectDropdownArray of options. Creates a drop-down list with selectable values.
multiSelectArray of options. Creates multi-select of checkboxes.
countrySelectDrop-down list with available countries.
fileAttachmentAllows uploading a single file as attachment to the applicant profile.
multiFileAttachmentsAllows uploading a multiple files as attachments to the applicant profile.

options element fields

The following table describes the options element fields.

FieldTypeDescriptionSupported values
valueStringThe option selected by the applicant.Any unique item identifier.
titleStringOptional title that will be shown to the applicant.Any string value.
localizedTitleObjectContains the title localization values.{"values":[{"lang":"en","value":"Option text"}]}
scoreDoubleAdds a value to the overall questionnaire scoring.Double value.

localization attributes

The following table describes how the localization of titles and descriptions is stored for different languages. Each localization is stored within the values array.

FieldTypeDescription
langStringLanguage in the ISO 639-1 alpha-2 code (en by default).
valueStringCorresponding text in the specified language. Empty ("") if not provided.

Response example

{
    "_id": "t8k4p7m1zq3l9x6r5b2v8n0",
    "id": "questionnaireId",
    "title": "Full questionnaire",
    "localizedTitle": {
        "values": [
            {
                "lang": "en",
                "value": "Full questionnaire"
            }
        ]
    },
    "desc": "Questionnaire description",
    "localizedDesc": {
        "values": [
            {
                "lang": "en",
                "value": "Questionnaire description"
            }
        ]
    },
    "clientId": "a8b4c9e7d2f6g1h3i0j5k8l7",
    "modifiable": null,
    "createdAt": "2024-10-11 14:58:40",
    "sections": [
        {
            "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": [
                {
                    "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
                },
                {
                    "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
                },
                {
                    "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
                },
                {
                    "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": "Type something",
                    "localizedPlaceholder": {
                        "values": [
                            {
                                "lang": "en",
                                "value": "Type something"
                            }
                        ]
                    },
                    "options": null
                },
                {
                    "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": "Type something",
                    "localizedPlaceholder": {
                        "values": [
                            {
                                "lang": "en",
                                "value": "Type something"
                            }
                        ]
                    },
                    "options": null
                }
            ],
            "delimiter": null
        },
        {
            "id": null,
            "title": null,
            "localizedTitle": {
                "values": [
                    {
                        "lang": "en",
                        "value": ""
                    }
                ]
            },
            "desc": null,
            "localizedDesc": {
                "values": [
                    {
                        "lang": "en",
                        "value": ""
                    }
                ]
            },
            "condition": null,
            "showCondition": null,
            "items": null,
            "delimiter": true
        },
        {
            "id": "section2Id",
            "title": "Section 2",
            "localizedTitle": {
                "values": [
                    {
                        "lang": "en",
                        "value": "Section 2"
                    }
                ]
            },
            "desc": "Section 2 description",
            "localizedDesc": {
                "values": [
                    {
                        "lang": "en",
                        "value": "Section 2 description"
                    }
                ]
            },
            "condition": null,
            "showCondition": null,
            "items": [
                {
                    "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
                },
                {
                    "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": "Type something",
                    "localizedPlaceholder": {
                        "values": [
                            {
                                "lang": "en",
                                "value": "Type something"
                            }
                        ]
                    },
                    "options": null
                },
                {
                    "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
                        }
                    ]
                },
                {
                    "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
                        }
                    ]
                },
                {
                    "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
                        }
                    ]
                }
            ],
            "delimiter": null
        },
        {
            "id": "section3Id",
            "title": "Section 3",
            "localizedTitle": {
                "values": [
                    {
                        "lang": "en",
                        "value": "Section 3"
                    }
                ]
            },
            "desc": "Section 3 description",
            "localizedDesc": {
                "values": [
                    {
                        "lang": "en",
                        "value": "Section 3 description"
                    }
                ]
            },
            "condition": null,
            "showCondition": null,
            "items": [
                {
                    "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
                },
                {
                    "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
                },
                {
                    "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": "Type something",
                    "localizedPlaceholder": {
                        "values": [
                            {
                                "lang": "en",
                                "value": "Type something"
                            }
                        ]
                    },
                    "options": null
                }
            ],
            "delimiter": null
        }
    ]
}
Language
Credentials
Header
Click Try It! to start a request and see the response here!