Get applicant levels

Returns a list of verification levels.

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 file that represents the list of all verification levels.

FieldTypeDescription
itemsArray of objectsEach object corresponds to a specific verification level.
totalItemsIntegerTotal 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.

FieldTypeDescription
idStringUnique verification level identifier.
nameStringThe level name given to the level when it was created, and that cannot be changed afterwards.
descStringOptional level description if it was added at creation.
requiredIdDocsObjectConfiguration of steps for the applicant to complete verification.

It includes step types (e.g. IDENTITY, SELFIE) and the documents appropriate for each step (e.g. 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.
websdkFlowIdStringUnique WebSDK customization identifier. Indicates that a WebSDK customization was added to the level.
msdkFlowIdStringUnique MSDK customization identifier. Indicates that a MobileSDK customization was added to the level.
createdAtDateThe date and time (GMT) when the level was created.
createdByStringLevel creator’s account name. Service means that it is a default level, the level created by the Sumsub support.
modifiedAtDateThe date and time (GMT) when the level was last modified.
customPrivacyNoteTextStringCustom processing consent text to be shown to your applicants on the agreement screen in the WebSDK (if added in the level settings).
watchListCheckSettingsObjectRepresents the level settings configured for AML screening.
useCustomWatchListCheckSettingsBooleanIndicates 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.
useCustomIdDocSettingsBooleanIndicates 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.
applicantInsightSettingsArray of booleansIncludes the fields advancedEmailCheckEnabled, advancedPhoneCheckEnabled, advancedIpCheckEnabled, and advancedIdentityEnrichmentEnabled indicating if the advanced checks for the applicant email, phone, IP address, and identity enrichment are enabled (true) on the level or not (false).
kytSettingsObjectContains 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).
typeEnumA level type assigned at the level creation when configuring verification steps.

  • standaloneStandard type for standard applicant verification.
  • actionsApplicant actions type for additional verification triggered by specific applicant activities.
  • moduleModule type to perform a Liveness & Face match check only.
actionTypeEnumThe field is available if a level belongs to the Applicant actions type, and indicates this action type.

applicantTypeEnumDefines 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.

FieldTypeDescription
videoIdentBooleanSpecifies if the video identification is required (true) or not required (false) to pass verification.
videoIdentUploadTypesArray of stringsLists 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.
stepsOutsideVideoIdArray of stringsLists the verification steps that can be passed outside the video identification.

The field is available if the video identification is required on the level.
docSetsArray of objectsIncludes the objects representing specific document sets and their attributes.

docSets element fields

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

FieldTypeDescription
idDocSetTypeStringA human-readable identifier of the document set type, for example, IDENTITY, SELFIE, PROOF_OF_RESIDENCE, and so on.
fieldsArray of objectsIncludes the objects describing the document data fields that should be filled with personal information to verify the applicant.

Each object contains the following attributes:

  • name (String) — the field name, for example, firstName, lastName, email, and so on.
  • required (Boolean) — true if the field is required for verification, false if not (still, it can be optionally filled in the SDK).
typesArray of stringsIncludes the types of documents that are required for a particular idDocSetType to pass verification.
videoRequiredStringMethod 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).
  • passiveLivenessliveness check.
  • docapture — enables the camera for the steps with ID documents, so applicants can take pictures of their documents in real time.
captureModeStringThis mode is applied in case the docapture method is used (see the table row above).

  • 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.
uploaderModeStringThis mode is applied in case the docapture method is used.

  • 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.
paymentMethodsArray of objectsDescribes the configuration details of the payment method added to the level.
questionnaireDefIdStringIdentifier of the questionnaire that is added to the verification level and is to be or has already been filled by the applicant.
Language
Authorization
Header
Click Try It! to start a request and see the response here!