get https://api.sumsub.com/resources/applicants/-/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.
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
items
element fieldsThe 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. |
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 (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. |
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. |
createdAt | Date | The date and time (GMT) when the level was created. |
createdBy | String | Level creator’s account name. Service means that it is a default level, the level created by the Sumsub support. |
modifiedAt | Date | The date and time (GMT) when the level was last modified. |
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). |
watchListCheckSettings | Object | Represents the level settings configured for AML screening. |
useCustomWatchListCheckSettings | Boolean | Indicates if custom AML screening settings are used on the level.
|
useCustomIdDocSettings | Boolean | Indicates if custom settings for supported ID documents are used on the level.
|
applicantInsightSettings | Array of booleans | Includes 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 ). |
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 ). |
type | Enum | A level type assigned at the level creation when configuring verification steps.
|
actionType | Enum | The field is available if a level belongs to the Applicant actions type, and indicates this action type.
|
applicantType | Enum | Defines the applicant type. Added automatically when the applicant profile is created.
|
requiredIdDocs
attributes
requiredIdDocs
attributesThe 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. |
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. |
docSets | Array of objects | Includes the objects representing specific document sets and their attributes. |
docSets
element fields
docSets
element fieldsThe 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 , and so on. |
fields | Array of objects | Includes the objects describing the document data fields that should be filled with personal information to verify the applicant. Each object contains the following attributes:
|
types | Array of strings | Includes the types of documents that are required for a particular idDocSetType to pass verification. |
videoRequired | String | Method of passing the document upload step that can be set up when configuring a verification level.
|
captureMode | String | This mode is applied in case the docapture method is used (see the table row above).
|
uploaderMode | String | This mode is applied in case the docapture method is used.
|
paymentMethods | Array of objects | Describes the configuration details of the payment method added to the level. |
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. |