When using the Questionnaire solution in your work, you can attach images to questionnaire answers by API, either for an applicant or as part of an applicant action.

Upload images to applicant profile questionnaire

Add images to a questionnaire in the applicant’s profile—create a verification level including the Questionnaire step and attach the required files.

Step 1. Add questionnaire

Create a questionnaire in the Dashboard:

1. Go to Integrations, navigate to the Questionnaires section, and click Create questionnaire.
2. Give it a name and optional description.
3. Add the File upload question type. You can enable the multiple file upload, if necessary.
4. View the generated questionnaire ID and edit it if needed. This ID is a crucial parameter required for API interactions.
5. Set up questionnaire content as per documentation.

Step 2. Create verification level with questionnaire step

Add a verification level including the Questionnaire step:

1. In the Dashboard, open the Individuals/Companies page and click Create level.
2. Include the Questionnaire step in the level and select the created questionnaire from the list.
3. Set the Standard level type.
4. Configure the verification level as needed.

Step 3. Add applicant profile

Create a new applicant profile associated with the level configured in Step 2:

1. Add a new applicant using the Create applicant method.
2. Make sure that the levelName parameter includes the verification level with the Questionnaire step.
3. Provide the rest of the parameters as per documentation of the method.

📘

Note

• The questionnaire answers can be left empty at this stage.
• To change a verification level for an existing applicant profile, use the Change required documents API method.

Step 4. Upload images to applicant

Attach images using the Add verification documents method.

Step 5. Retrieve IDs of uploaded images

Get the IDs of uploaded images via the Get information about document images API method.

Use the id attribute received from the response.

Step 6. Submit answers and attach images to questionnaire

Use the Add applicant questionnaire method to complete the questionnaire and send its data via API:

1. Get the attributes of your questionnaire by one of the following methods:
   1. Open the Questionnaires page, find the necessary questionnaire, and select Export.
   2. Open the Questionnaires page, click on any questionnaire from the list, and find all the necessary IDs in editing mode.
2. Use the questionnaire structure of this request example to prepare the API request and fill out a questionnaire with custom attributes.
3. Attach images using the items object (with the required question ID and File upload type)—submit the image ID via the value/values fields. See the example.
4. Send the completed request.

Upload images to applicant action questionnaire

Attach images in the applicant actions based on the Questionnaire step—create a verification level with an action type, and submit all required data.

Step 1. Add questionnaire

Create a questionnaire in the Dashboard:

1. Go to Integrations, navigate to the Questionnaires section, and click Create questionnaire.
2. Give it a name and optional description.
3. Add the File upload question type. You can enable the multiple file upload, if necessary.
4. View the generated questionnaire ID and edit it if needed. This ID is a crucial parameter required for API interactions.
5. Set up questionnaire content as per documentation.

Step 2. Create verification level with questionnaire step

Add a verification level with the Applicant actions type and include the Questionnaire step:

1. In the Dashboard, open the Individuals/Companies page and click Create level.
2. Include the Questionnaire step in the level and select the created questionnaire from the list.
3. Set the Applicant actions level type.
4. Configure the verification level as needed.

📘

Note

To make a verification level an action, you need to include only specific verification steps indicated below. If the verification level contains any other steps, the type setting will be limited to the Standard option:

• Selfie
• Payment methods
• Questionnaire
• Phone verification
• Email verification

Refer to the Applicant actions article to learn more about this verification type and its settings.

Step 3. Create applicant action

Add an applicant action associated with the created level:

1. Create the applicant action using the Create applicant action method.
2. Make sure that the levelName parameter includes the verification level with the Questionnaire step.

📘

Note

There’s no need to submit questionnaire answers at this step.

Step 4. Upload images to applicant action and retrieve their IDs

Submit images and get their IDs via the Add image to applicant action method.

Use the imageId attribute received from the response.

Step 5. Submit answers and attach images to questionnaire action

Use the Add applicant action questionnaire method to complete the questionnaire and send its data via API:

1. Get the attributes of your questionnaire by one of the following methods:
   1. Open the Questionnaires page, find the necessary questionnaire, and select Export.
   2. Open the Questionnaires page, click on any questionnaire from the list, and find all the necessary IDs in editing mode.
2. Use the questionnaire structure of this request example to prepare the API request and fill out a questionnaire with custom attributes.
3. Attach images using the items object (with the required question ID and File upload type)—submit the image ID via the value/values fields. See the example.
4. Send the completed request.