Questionnaire API
Get the questionnaire results via API.
To get the results of the questionnaire step via API, use this method.
Items with the type of fileAttachment contain the imageId value that you can use to fetch the uploaded files.
The following is a response example:
{
"id": "5e9a35d30a975a656d67d473",
"createdAt": "2020-04-17 23:03:47",
"clientId": "yourClientId",
"inspectionId": "5e9a35d30a975a656d67d474",
"externalUserId": "random-userId",
"requiredIdDocs": {
"docSets": [
{
"idDocSetType": "QUESTIONNAIRE",
"questionnaireDefId" : "ExampleQuestionnaire"
}
]
},
"review": {
"elapsedSincePendingMs": 302957,
"elapsedSinceQueuedMs": 25213,
"createDate": "2020-04-17 23:05:46+0000",
"reviewDate": "2020-04-17 23:10:49+0000",
"startDate": "2020-04-17 23:10:24+0000",
"reviewResult": {
"reviewAnswer": "GREEN"
},
"reviewStatus": "completed"
},
"lang": "en",
"type": "individual",
"questionnaires": [
{
"id": "ExampleQuestionnaire",
"sections": {
"bankDetails": {
"score" : 0.0,
"items": {
"2-1": {
"value": null,
"values": null
},
"2-2": {
"value": null,
"values": null
},
"2-3": {
"value": null,
"values": null
},
"2-4": {
"value": null,
"values": null
},
"2-5": {
"value": null,
"values": null
},
"2-6": {
"value": null,
"values": null
},
"2-7": {
"value": null,
"values": null
},
"2-8": {
"value": null,
"values": null
}
}
},
"withInstitution": {
"score" : 0.2,
"items": {
"3-1": {
"value": "e-wallet",
"score" : 0.2
}
}
},
"fileAttachments": {
"score" : 0.0,
"items": {
"firstFile": {
"value": "2046918100", //imageId
"values": null
},
"anotherFile": {
"value": "2046918189", //imageId
"values": null
}
}
},
"accountDetails": {
"score" : 1.4,
"items": {
"1-2one": {
"value": null,
"values": null
},
"1-1": {
"value": "Legal Name LTD"
},
"1-2": {
"value": "two"
},
"1-2two": {
"value": "sumsub.com"
},
"1-4": {
"value": "no",
"score" : 0.4
},
"1-5": {
"value": "no",
"score" : 1.0
},
"1-email": {
"value": "[email protected]"
},
"1-country": {
"value": "GBR"
}
}
}
},
"score" : 1.6
}
]
}
Definition attributes
The following table describes the questionnaireDef attributes:
| Name | Type | Required | Description |
|---|---|---|---|
id | String | Yes | A unique questionnaire identification number. |
title | String | No | A questionnaire title. |
desc | String | No | An optional questionnaire description. |
sections | Array | Yes | An array of questionnaire sections. |
Note
Each questionnaire
IDattribute should be unique. If you intend to change the questionnaire structure, IDs should not be reused.
Section fields
The following table describes the sections attributes:
| Name | Type | Required | Description |
|---|---|---|---|
id | String | Yes | A unique section identification number. |
title | String | No | A section title. |
desc | String | No | An optional section description. |
condition | String | No | A condition that makes the section visible, depending on the value of specified sectionId.itemId={options.value}. |
items | Array | Yes | An array of questionnaire items (data fields). |
Item fields
The following table describes the items attributes:
| Name | Type | Required | Description | Supported values |
|---|---|---|---|---|
id | String | Yes | A unique item identification number. | Any unique item identifier. |
title | String | No | Data field title. | Any string value. |
desc | String | No | An optional data field description. | Any string value. |
type | String | Yes | Data field type. | See Supported types of items. |
required | Boolean | No | Sets the data field as mandatory to fill. | true or false. |
format | String | No | The format of the data field with validation. | min:3, max:9 (sets min/max amount of symbols), email. |
placeholder | String | No | A placeholder for text data field. | Any string value. |
options | Array | No | An array of values to select from. | [{"value": "someValue", "title": "Yes", "score": 0}] |
condition | String | No | A condition that makes item show up. | sectionId.itemId={options.value} ( Example: 1-Section.1-2=someValue ) |
Supported types of items
The following table describes the supported types of items:
| Value | Description |
|---|---|
text | A text field. |
textArea | An expandable text area. |
date | Date field in format mm/dd/yyyy. |
dateTime | Shows the calendar with date and time fields. |
bool | A single checkbox. |
select | An array of options. Creates radio buttons. |
selectDropdown | An array of options. Creates a drop-down list with selectable values. |
multiSelect | An array of options. Creates multi-select of checkboxes. |
countrySelect | A drop-down list with available countries. |
fileAttachment | Allows uploading a file to the applicant as an attachment. |
Option attributes
The following table describes the options attributes:
| Name | Type | Required | Description | Supported values |
|---|---|---|---|---|
value | String | Yes | The value that you will get via API as the option selected by the applicant. | Any unique item identifier. |
title | String | Yes | An optional title that will be shown to the applicant. | Any string value. |
score | Double | No | Adds a value to the overall questionnaire scoring (score). | Double value. |
Questionnaire translations
You can change a questionnaire locale by using SDK translations.
The following is a translation example:
"questionnaires": {
"questionnaireTranslate": {
"title": "I18n questionnaire title",
"desc": "I18n questionnaire description",
"sections": {
"section1": {
"title": "I18n section title",
"desc": "I18n section description",
"items": {
"item1": {
"title": "I18n item title",
"desc": "I18n item description",
"options":{
"value1": "I18n option title 1",
"value2": "I18n option title 2"
}
}
}
}
}
}
}
Updated 4 months ago