post https://api.sumsub.com/resources/applicants//questionnaires
Creates and updates questionnaires.
Overview
Use this method to create a new questionnaire or to update the details of an existing one.
Request example
The following example demonstrates a questionnaire structure that you can use to create a JSON body based on your questionnaire parameters.
Important
Make sure to always provide a questionnaire
idthat exists on your client key.
{
"id": "Example_Questionnaire",
"sections": {
"section_id_1": { // Section ID
"items": {
"item_id_0": { // Item ID
"values": [ // Item values
"EUR",
"USD"
]
},
"item_id_1": {
"value": "String Value"
}
}
},
"section_id_2": {
"items": {
"item_id_3": {
"value": null
}
}
},
"section_id_3": {
"items": {
"item_id_4": {
"value": "856090714", // Image ID
}
}
}
}
}
Attributes
The following are the root attributes of each questionnaire:
| Name | Type | Required | Description |
|---|---|---|---|
id | String | Yes | A unique questionnaire identification number. |
sections | Array | Yes | Consists of questions that must be passed as nested items objects. The number of sections may vary and depends upon the structure of your particular questionnaire. The value field indicates the answer to any given question and the values array indicates multiple answers. |
Questionnaire example
{
"id": "Example_Questionnaire",
"sections": {
"accountDetails": {
"items": {
"1-0": {
"values": [
"EUR",
"USD"
]
},
"1-1": {
"value": "Luciano"
},
"1-2": {
"value": "yes"
},
"1-3": {
"value": "test.com"
},
"1-4": {
"value": "merchant"
},
"1-5": {
"value": "yes"
},
"1-email": {
"value": "[email protected]"
}
}
},
"bankDetails": {
"items": {
"2-1": {
"value": "Test Bank"
},
"2-2": {
"value": "Italy"
},
"2-3": {
"value": "Non-American"
},
"2-4": {
"value": "Naples, Italy"
},
"2-5": {
"value": "F833FK"
},
"2-6": {
"value": "IFKD87FG"
},
"2-7": {
"value": "yes"
},
"2-8": {
"value": null
}
}
},
"employmentStatus": {
"items": {
"countryOfIncome": {
"value": "ITA"
},
"uploadTheDocumentsTo": {
"value": null
},
"whatIsYourCurrentEmp": {
"value": "self-employed"
}
}
},
"withInstitution": {
"items": {
"3-1": {
"value": null
}
}
}
}
}