Overview

Use this method to get the fully structured view of all available verification levels in your project.

Response explained

The response is a JSON object containing all verification levels configured in your project and their corresponding settings.

📘
Note
The presence of some fields in the response depends on the level type and its configuration.

Field	Type	Description
`items`	Array of objects	Each object corresponds to a specific verification level.
`totalItems`	Integer	Total number of all verification levels.

`items` element fields

The following table explains the items element fields representing the attributes and configuration details of verification levels. The existence of some fields depends on the level types and settings.

Field	Type	Description
`id`	String	Unique verification level identifier.
`clientId`	String	Unique identifier of you as our client in the Sumsub system. This identifier is assigned to you when you are registered in and get access to the Sumsub system. It usually resembles your name or your company name. `clientId` is automatically added to the applicant profile when it is created.
`name`	String	The level name given to the level when it was created, and that cannot be changed afterwards.
`desc`	String	Optional level description, if it was added at creation.
`requiredIdDocs`	Object	Configuration of steps for the applicant to complete verification. It includes step types (for example, `IDENTITY`, `SELFIE`) and the documents appropriate for each step (for example, `PASSPORT`, `ID_CARD`, `RESIDENCE_PERMIT`), or necessary data fields to be filled in. For example, the `APPLICANT_DATA` step type includes a list of fields the applicant must fill in, so we could proceed with verification.
`notificationSettings`	Object	Applicant email notification triggers configured for this verification level. Contains the `applicantNotificationState` field — an array of enum strings indicating when email notifications should be sent to the applicant: `approved` — email notification is sent when an applicant is approved. `resubmission` — email notification is sent when an applicant requires resubmission. `rejected` — email notification is sent when an applicant is rejected.
`websdkFlowId`	String	Unique WebSDK customization identifier. Indicates that a WebSDK customization was added to the level.
`msdkFlowId`	String	Unique MSDK customization identifier. Indicates that a MobileSDK customization was added to the level.
`sdkTranslationName`	String	Custom SDK translation name assigned to this level.
`created`	Object	Contains information about the creation of the verification level. Parameters: `date` — date and time (GMT) when the level was created. `clientSubject` — name of the account that created the level. The value `Service` indicates that the level is a default one or created by the Sumsub support.
`modified`	Object	Contains information about the modification of the verification level. Parameters: `date` — date and time (GMT) when the level was last modified. `clientSubject` — name of the account that last modified the level. The value `Service` indicates that the level is a default one or modified by the Sumsub support.
`createdAt`	Date	Date and time (GMT) when the level was created. ⚠️ This field is deprecated and will be removed in the future.
`createdBy`	String	Level creator’s account name. `Service` means that it is a default level, or the level created by the Sumsub support. ⚠️ This field is deprecated and will be removed in the future.
`modifiedAt`	Date	Date and time (GMT) when the level was last modified. ⚠️ This field is deprecated and will be removed in the future.
`idDocSettings`	Object	Contains information about custom settings for supported ID documents (if set for the level).
`customPrivacyNoteText`	String	Custom processing consent text to be shown to your applicants on the agreement screen in the WebSDK (if added in the level settings).
`customPrivacyLink`	String	Custom processing consent link to be shown to your applicants on the agreement screen in the WebSDK (if added in the level settings).
`productionOnly`	Boolean	Indicates if a level should be available only in Production mode (`true`). Returned if Visibility configuration in the advanced settings is enabled.
`disableWatchlists`	Boolean	Indicates if AML Screening is disabled (`true`) in the level settings.
`rejectUsaResidents`	Boolean	Indicates if the setting `Reject USA residents if they confirm US residency in SDK` is enabled (`true`).
`watchListCheckSettings`	Object	Represents AML screening settings configured for the applicant level.
`useCustomWatchListCheckSettings`	Boolean	Indicates if custom AML screening settings are used on the level. `true` — custom AML screening settings are used on the level instead of global settings. `false` — global settings are used.
`useCustomIdDocSettings`	Boolean	Indicates if custom settings for supported ID documents are used on the level. `true` — custom settings for supported ID documents are used on the level instead of global settings. `false` — global settings are used.
`applicantSourceKey`	String	Identifies the applicant Source key if the verification level is assigned to applicants originating from specific sources.
`applicantInsightSettings`	Object	Includes the fields `advancedEmailCheckEnabled`, `advancedPhoneCheckEnabled`, `advancedIpCheckEnabled`, `advancedIdentityEnrichmentEnabled`, and `aiSuspiciousNameCheckEnabled` indicating if the advanced checks for the applicant email, phone, IP address, identity enrichment, and AI suspicious name check are enabled (`true`) on the level or not (`false`).
`agreementSettings`	Object	Contains the `skipAgreementStep` boolean field that indicates whether the consent screen is skipped in the SDK.
`kytSettings`	Object	Contains the `createKycTxns` boolean parameter that indicates if the option to calculate the onboarding risk score of your applicants is enabled (`true`) on the level or not (`false`).
`deviceIntelligenceSettings`	Object	Contains the `enabled` boolean field that indicates whether Device Intelligence is enabled (`true`) for this level or not (`false`).
`ipRestrictionSettings`	Object	Describes the configuration details of IP and VPN detection settings added to the level.
`checkSourceSettings`	Object	Describes the configuration details of the Database Validation setting of the level.
`type`	Enum	A level type assigned at the level creation when configuring verification steps. `standalone` — Standard type for standard applicant verification. `actions` — Applicant actions type for additional verification triggered by specific applicant activities. `module` — Module type to perform a Liveness & Face match check only.
`actionType`	Enum	The field is available if a level belongs to the Applicant actions type, and indicates this action type. `paymentMethod` — action to check a payment method. `faceEnrollment` — Liveness & Face match check.
`applicantType`	Enum	Defines the applicant type. Added automatically when the applicant profile is created. `individual` — for applicants registered and checked as individuals. `company` — for applicants registered and checked as legal entities.

`requiredIdDocs` attributes

The requiredIdDocs object represents the configuration of steps for the applicant to complete verification. It includes a set of required documents and data to provide.

Field	Type	Description
`videoIdent`	Boolean	Specifies if the video identification is required (`true`) or not required (`false`) to pass verification.
`videoIdentSettings`	Object	Contains the `resetAllStepsOnEachAttempt` boolean field that indicates whether each new video identification resubmission must start from the beginning with all required steps defined for the verification level, regardless of which steps were previously completed successfully. If enabled (`true`) — the applicant must repeat all verification steps on every new attempt from the beginning. If disabled (`false`) — only incomplete or failed steps must be repeated. ⚠️ This field is available only if the setting is configured for the level.
`videoIdentUploadTypes`	Array of strings	Lists the document types that can be uploaded during a video interview, if such documents are specified in the level settings. The field is available if the video identification is required on the level.
`stepsOutsideVideoId`	Array of strings	Lists the verification steps that can be passed outside the video identification. The field is available if the video identification is required on the level.
`includedCountries`	Array of strings	Countries (in ISO 3166-1 alpha-3 country code, for example, `DEU`, `GBR`, `ARG`) that are included in the list of supported.
`excludedCountries`	Array of strings	Countries (in ISO 3166-1 alpha-3 country code, for example, `DEU`, `GBR`, `ARG`) that are excluded from the list of supported.
`docSets`	Array of objects	Includes the objects representing specific document sets and their attributes.
`kybSettings`	Object	Available for company applicants. Includes the settings that are used to identify the types of company beneficiaries, to enable/disable company search in selected registry databases and automatic verification of the company's ownership and control structure.

`docSets` element fields

The following table explains the element fields of the docSets array representing specific document sets and their attributes.

Field	Type	Description
`idDocSetType`	String	A human-readable identifier of the document set type (for example, `IDENTITY`, `SELFIE`, `PROOF_OF_RESIDENCE`).
`types`	Array of strings	Includes the types of documents that are required for a particular `idDocSetType` to pass verification.
`subTypes`	Array of strings	List of document subtypes required for verification (applicable only to company documents).
`videoRequired`	String	Method of passing the document upload step that can be set up when configuring a verification level. `disabled` — selfie with a document. `enabled` — video selfie with a phrase. `photoRequired` — web camera photo (still face image). `passiveLiveness` — liveness check. `docapture` — enables the camera for the steps with ID documents, so applicants can take pictures of their documents in real time.
`captureMode`	String	Applicable only when `videoRequired=docapture`. `manualAndAuto` — allows both to automatically capture the photo of a document when the camera is initialized, and for the applicant to hit a button to take a photo. `manualOnly` — allows only manually hitting a button to take a photo. `seamless` — Seamless ID Capture mode for QES.
`uploaderMode`	String	Applicable only when `videoRequired=docapture`. `always` — always allows uploading a ready-made photo instead of using a camera. `never` — does not allow uploading a ready-made photo. `fallback` — allows uploading a ready-made photo only if a camera is not available.
`fields`	Array of objects	Contains objects that define the document data fields to be populated with personal information for verifying the applicant during the Applicant data verification step.
`customFields`	Array of objects	Contains objects that describe custom fields if they are created for the Applicant data verification step.
`questionnaireDefId`	String	Identifier of the questionnaire that is added to the verification level and is to be or has already been filled by the applicant.
`poaStepSettingsId`	String	Identifier of the selected Proof of Address preset.
`companyBeneficiaryDefinitions`	Array of objects	Specification of level steps to be fulfilled. Stands for Associated parties. Available for company applicants.
`companyDocsGroupDefinitions`	Array of objects	Definitions of the required document groups for verification. Available for company applicants.
`captureParams`	Object	Describes the capture method and related settings for this step. Contains the `inputType` enum attribute, which defines how data is captured. Possible values: `fileUpload` — upload a file. `cameraStream` — capture a web camera photo or a short video fragment. `liveness` — perform an advanced liveness check. `docapture` — perform live document capture. If `inputType=cameraStream`, the `cameraStream.contentType` field is returned: `image` — for web camera photo `video` — for short video fragment. If `inputType=docapture`, the `docapture.captureMode` and `docapture.uploaderMode` fields are returned.
`ekycAllowed`	Boolean	Indicates if Non-Doc Verification for the step is allowed (`true`) or not (`false`).
`checkSourceSettings`	Object	Describes the configuration of the Database Validation setting for the verification level.
`esignSettings`	Object	Contains configuration for the E-sign verification step, including objects that define the document to be signed (ID and name) and signature settings.
`restrictCountries`	Boolean	Returns `true` if the verification step restricts applicants from specific countries. Otherwise the field is not returned.
`skipAllowed`	Boolean	Indicates whether this verification step can be skipped (`true`) or not (`false`). Available only for steps that support the skip option.
`nfcVerificationSettings`	Object	Contains the `mode` parameter that defines NFC-based ID verification behavior. Possible values: `disabled` — NFC chip reading is not requested from applicants. `optional` — if the document contains an NFC chip, the system requests a chip reading. Applicants may complete or skip this step. If skipped or if scanning fails, verification continues using the standard document-based flow. `required` — if the document contains an NFC chip, the system requires a successful chip reading. Skipping or fallback to document-based verification is not allowed.
`phoneVerificationSettings`	Object	Contains the `immutablePhoneIfPresent` boolean field, which controls whether applicants can edit their pre-filled phone number. `true` — editing is disabled. `false` — editing is allowed. not returned — editing is allowed, or the setting is not supported for the verification step.
`emailVerificationSettings`	Object	Contains the `immutableEmailIfPresent` boolean field, which controls whether applicants can edit their pre-filled email address. `true` — editing is disabled. `false` — editing is allowed. not returned — editing is allowed, or the setting is not supported for the verification step.
`selfieProcessingSettings`	Object	Contains the `skipLivenessCheck` boolean field, which indicates whether the Skip liveness check setting is enabled. `true` — enabled. `false` — disabled. not returned — disabled, or the setting is not supported for the verification step.
`applicantDataSettings`	Object	Contains the `prefill` boolean field, which indicates whether the applicant data form is prefilled in the SDK step. `true` — pre-fill is enabled. `false` — pre-fill is disabled. not returned — pre-fill is disabled, or the setting is not supported for the verification step.

`fields` element fields

The following table explains the fields element fields.

Field	Type	Description
`name`	String	Field name (for example, `firstName`, `lastName`, `email`).
`required`	Boolean	`true` if the field is required for verification, `false` if not (still, it can be optionally filled in the SDK).
`prefill`	Boolean	`true` if the field is pre-populated in the SDK, `false` if not.
`immutableIfPresent`	Boolean	`true` if the field is locked and cannot be edited by the applicant; `false` otherwise.

`customFields` element fields

The following table explains the customFields element fields.

Field	Type	Description
`name`	String	System name of the custom field.
`displayName`	String	Name of the field as it is shown to the applicant.
`required`	Boolean	Returns `true` if the field is required for verification, `false` if not (still, it can be optionally filled in the SDK).

`companyBeneficiaryDefinitions` element fields

The following table explains the companyBeneficiaryDefinitions element fields.

Field	Type	Description
`category`	String	Beneficiary role name (`ubos`, `shareholders`, `directors`).
`canSkip`	Boolean	Indicates if it is skippable via SDK: `true` — yes, `false` — no.
`individual`	Object	Contains information on the associated party as an individual applicant.
`company`	Object	Contains information on the associated party as a company applicant.

`individual` and `company` attributes

the following table explains the individual and company attributes.

Field	Type	Description
`enabled`	Boolean	Nested KYC (for individuals) or KYB (for companies) verification enabled for this role: `true` — yes, `false` — no.
`levelName`	String	Name of the verification level. There is no length limit for this field.
`fields`	Array of objects	Includes the objects describing the data fields that should be filled with personal information to verify the applicant.
`customFields`	Array of objects	Includes the objects each of those represents an additional custom field (`applicantIdDocSetCustomField`) that should be filled for verification.

`companyDocsGroupDefinitions` element fields

The following table explains the companyDocsGroupDefinitions element fields.

Field	Type	Description
`label`	String	Label of the document group. Available labels: `legalPresence`, `companyDetails`, `ownershipStructure`, `controlStructure`, `representativesAuthorization`, `other1`, `other2`, `other3`.
`subTypes`	Array of strings	List of document types included into the verification group.
`required`	Boolean	Indicates if this is required (`true`) or optional (`false`).

`kybSettings` attributes

The following table explains the kybSettings attributes.

Field	Type	Description
`shareholderThreshold`	Integer	Ownership percentage threshold used to classify an individual beneficiary as a shareholder. If `shareholderThreshold` is less and `uboThreshold` is greater than the ownership percentage, then the individual is a shareholder. Companies are always classified as shareholders.
`uboThreshold`	Integer	Ownership percentage threshold used to classify an individual beneficiary as a UBO (Ultimate Beneficial Owner). If the ownership percentage is greater than or equal to `uboThreshold`, then the individual is a UBO. Companies are always classified as shareholders.
`disableCompanySearchAndPrefill`	Boolean	Indicates whether company search in selected corporate registry databases for pre-filling company and associated parties’ data is disabled (`true`) or enabled (`false`).
`enableBeneficiariesAutoCheck`	Boolean	Indicates whether automatic verification of the company’s ownership and control structure against selected corporate registries is enabled. When enabled (`true`), the system compares the applicant-provided ownership and management information (for example, shareholders and directors) with official registry data and flags discrepancies. When disabled (`false`), this verification is not performed.

`watchListCheckSettings` attributes

The following table describes the watchListCheckSettings attributes.

Field	Type	Description
`amlCaseType`	Enum	AML watchlist screening provider. `caSearch` — ComplyAdvantage `wcCase` — World-Check One `quantifindSearch` — Quantifind `caMeshSearch` — ComplyAdvantage Mesh
`ongoingMonitoringEnabled`	Boolean	Identifies whether Ongoing AML monitoring is enabled (`true`) or disabled (`false`).
`delegateWlOngoing`	Boolean	Indicates whether approved applicants matched against AML watchlists during ongoing monitoring are automatically routed for manual review.
`complyAdvantage`	Object	Returned only when `amlCaseType=caSearch`. Contains configuration settings for ComplyAdvantage screening.
`complyAdvantageMesh`	Object	Present only when `amlCaseType=caMeshSearch`. Defines ComplyAdvantage Mesh configuration settings. Contains the `screeningConfigurationId` (String) parameter, which identifies the selected ComplyAdvantage Mesh screening preset: `0197ea21-5904-72bf-8fa6-059771cc14f2` — Best Approval Rate. `0197ea8a-7cae-7e68-87b1-97f64fa98b5c` — Default. `0197ea8c-4853-7dd3-9613-31693d13b901` — Expanded screening. `0198186d-5bae-7bad-bdb2-79f2e45e6690` — Extensive screening. `0198186d-fd77-77cc-869e-727dc9e533b3` — Counterparty Sanctions Screening.
`quantifind`	Object	Returned only when `amlCaseType=quantifindSearch`. Contains configuration settings for Quantifind screening.
`worldCheckOne`	Object	Returned only when `amlCaseType=wcCase`. Contains configuration settings for World-Check One screening, including the `groupName` (String) parameter that identifies the World-Check One group name.

`complyAdvantage` attributes

The following table explains the complyAdvantage attributes.

Field	Type	Description
`warningTypes`	Array of strings	Specifies the warning categories included in the watchlist search (for example, `sanction`, `pep-class-1`, `warning`).
`fuzziness`	Enum	Name matching criteria: `strict` — returns exact name matches and matches with minor variations. `def` (default) — returns exact name matches and allows a small difference between names. `fuzzy` — returns exact name matches and allows the widest range of spelling differences including non-phonetic matches.
`exactMatch`	Boolean	Indicates if only exact name matches are flagged (`true`). Exact match disables all standard and optional matching behaviours, and overrides `fuzziness`.
`searchProfile`	String	ComplyAdvantage Search profile ID (if used instead of `warningTypes` for watchlist screening).

`quantifind` attributes

The following table explains the quantifind attributes.

Field	Type	Description
`minRiskLevel`	Enum	Minimum risk level used for watchlist checks. `high` — high risk records only. `medium` — medium risk records and higher. `neutral` — neutral risk records and higher. `noRisk` — all records with any risk level.
`minConfidenceLevel`	Enum	Minimum confidence level used for watchlist checks: `Strong` or `Fair`.
`includeDataSources`	Boolean	Indicates the data source exclusion/inclusion policy: `true` — include data sources. `false` or `null` — exclude data sources.
`includeRiskFactors`	Boolean	Indicates the risk factors exclusion/inclusion policy: `true` — include risk factors. `false` or `null` — exclude risk factors.
`dataSources`	Array of strings	List of data sources that are included or excluded based on the `includeDataSources` setting.
`riskFactors`	Array of strings	List of risk factors that are included or excluded based on the `includeRiskFactors` setting.
`segmentId`	String	Quantifind segment ID for ongoing monitoring.

`ipRestrictionSettings` attributes

The following table describes the ipRestrictionSettings attributes.

Field	Type	Description
`restrictVpn`	Boolean	Indicates if the setting Pause verification if VPN is detected is enabled (`true`) on the level or not (`false`).
`restrictCountries`	Boolean	Indicates if the level is configured to control applicant IP addresses by allowing or blocking selected countries.
`includedCountries`	Array of strings	List of countries from which applicants are allowed to start verification based on their IP address.
`excludedCountries`	Array of strings	List of countries from which applicants are not allowed to start verification based on their IP address.

Response examples

If the request is successfully sent and processed, you will get a response like the one below. This example shows a response where a single verification level is created with two steps: Identity document and Selfie.

{
  "list": {
    "items": [
      {
        "id": "exampleId",
        "clientId": "exampleClientId",
        "name": "levelName",
        "desc": "levelDescription",
        "requiredIdDocs": {
          "docSets": [
            {
              "idDocSetType": "IDENTITY",
              "types": [
                "ID_CARD",
                "PASSPORT",
                "RESIDENCE_PERMIT",
                "DRIVERS"
              ],
              "videoRequired": "disabled",
              "captureParams": {
                "inputType": "fileUpload"
              }
            },
            {
              "idDocSetType": "SELFIE",
              "types": [
                "SELFIE"
              ],
              "videoRequired": "passiveLiveness",
              "captureParams": {
                "inputType": "liveness"
              }
            }
          ]
        },
        "created": {
          "date": "2026-01-16 07:59:14",
          "clientSubject": "exampleclientSubject"
        },
        "modified": {
          "date": "2026-01-16 07:59:14",
          "clientSubject": "exampleclientSubject"
        },
        "createdAt": "2026-01-16 07:59:14",
        "createdBy": "exampleclientSubject",
        "modifiedAt": "2026-01-16 07:59:14",
        "applicantType": "individual"
      }
    ],
    "totalItems": 1
  }
}

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

{
  "code": 401,
  "correlationId": "abc123",
  "description": "App token signature mismatch",
  "errorCode": 4003
}

Get applicant levels

Overview

Response explained

📘
Note

`items` element fields

`requiredIdDocs` attributes

`docSets` element fields

`fields` element fields

`customFields` element fields

`companyBeneficiaryDefinitions` element fields

`individual` and `company` attributes

`companyDocsGroupDefinitions` element fields

`kybSettings` attributes

`watchListCheckSettings` attributes

`complyAdvantage` attributes

`quantifind` attributes

`ipRestrictionSettings` attributes

Response examples

Overview

Response explained

📘Note

items element fields

requiredIdDocs attributes

docSets element fields

fields element fields

customFields element fields

companyBeneficiaryDefinitions element fields

individual and company attributes

companyDocsGroupDefinitions element fields

kybSettings attributes

watchListCheckSettings attributes

complyAdvantage attributes

quantifind attributes

ipRestrictionSettings attributes

Response examples

📘
Note

`items` element fields

`requiredIdDocs` attributes

`docSets` element fields

`fields` element fields

`customFields` element fields

`companyBeneficiaryDefinitions` element fields

`individual` and `company` attributes

`companyDocsGroupDefinitions` element fields

`kybSettings` attributes

`watchListCheckSettings` attributes

`complyAdvantage` attributes

`quantifind` attributes

`ipRestrictionSettings` attributes