Overview

Use this method to retrieve a list of all verification levels that include verification steps linked to questionnaires.

Request example

curl -X GET \
  'https://api.sumsub.com/resources/api/questionnaires/usedByLevels'

Response explained

The response is a JSON object containing a list of all verification levels linked to questionnaires.

The following is a root-level attribute:

Field	Type	Description
`list`	Object	Includes data with `items`, `totalItems`.

`list` attributes

The following table explains the list attributes.

Field	Type	Description
`items`	Array of objects	Each item is an object that represents a link between a verification level and a questionnaire. ⚠️ When a verification level is linked to multiple questionnaires, the `items` array includes separate objects for each linked questionnaire, all sharing the same level identifier.
`totalItems`	Integer	Total number of items in the list.

`items` element fields

The following table describes the fields of each items element, indicating the verification levels to which specific questionnaires are linked.

Field	Type	Description
`levelId`	String	Unique verification level identifier.
`levelName`	String	The level name given to the verification level when it was created, and that cannot be changed afterwards.
`questionnaireId`	String	Unique entity identifier of the questionnaire. It is automatically assigned to the ID field during questionnaire creation and can be modified before the questionnaire is created. Used for most questionnaire-linked scenarios in the Dashboard.

Response examples

If the request is sent and processed successfully, you will receive a response like the following:

{
  "list": {
    "items": [
      {
        "levelId": "67adcf32e0f915153a73327b",
        "levelName": "full_verification_level",
        "questionnaireId": "questionnaire1"
      },
      {
        "levelId": "67ade7d9df11be7bcaf2d5b7",
        "levelName": "advanced_level",
        "questionnaireId": "questionnaire3"
      },
      {
        "levelId": "67adcf32e0f915153a767266",
        "levelName": "multiple-questionnaires-level",
        "questionnaireId": "questionnaire1"
      },
      {
        "levelId": "67adcf32e0f915153a767266",
        "levelName": "multiple-questionnaires-level",
        "questionnaireId": "questionnaire2"
      }
    ],
    "totalItems": 4
  }
}

If the request fails, you will receive an HTTP response containing an error code along with a message explaining the error. For example:

{
  "code": 403,
  "correlationId": "67c0b4b9034£920db5ee0£d9сc2a0d£c",
  "description": "You don't have this feature enabled, please contact us"
}