Verification levels

Use these methods to manage verification levels configured in the Back Office and obtain information about them.

GET[host]/api/v2/verifications/levels

Get a list of verification levels

GET[host]/api/v2/verifications/levels/{levelId}

Get verification level details

POST[host]/api/v2/verifications/levels

Create a new verification level

PUT[host]/api/v2/verifications/levels/{levelId}

PATCH[host]/api/v2/verifications/levels/{levelId}

Update a verification level

DELETE[host]/api/v2/verifications/levels/{levelId}

Delete a verification level

Get a list of verification levels

Use this method to obtain a list of all verification levels created in the Back Office.

To obtain detailed information about a specified verification level, use a separate method to get verification level details.

Request

Header parameters:

  • Authorization: Bearer <access_token>

GET[host]/api/v2/verifications/levels

curl --location --request GET 'https://host.name/api/v2/verifications/levels?limit=10&offset=0' \
--header 'Authorization: Bearer <token>'

Response

A response includes an array of Verification Level objects providing information about all verification levels created in the Back Office.

Get verification level details

Use this method to obtain detailed information about a specified verification level.

To obtain a list of all verification levels created in the Back Office, use a separate method to get a list of verification levels.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Path parameters:

levelId required

The identifier of a verification level.

GET[host]/api/v2/verifications/levels/{levelId}

curl --location --request GET 'https://host.name/api/v2/verifications/levels/1' \
--header 'Authorization: Bearer <token>'

Response

A response includes a Verification Level object providing information about the specified verification level.

Create a new verification level

Use this method to create a new verification level.

Request

Header parameters:

  • Authorization: Bearer <token>

Body:

Specify the following parameters for a verification level:

index integer required

The index assigned to a verification level.

The zero (0) index is always assigned to the default verification level. For the other verification levels, the index must be greater than zero.

caption string required

The verification level name displayed in the B2Core UI.

description string required

The verification level description displayed in the B2Core UI.

visible boolean required

If true, a verification level is displayed to clients in the B2Core UI; otherwise, false.

default boolean required

If true, a verification level is the default one and granted to all newly registered clients; otherwise, false.

sustainable boolean required

This parameter must be set to false.

wizard string

The name of a wizard used to run a verification procedure in the B2Core UI.

levelId integer

The identifier of a verification level.

mailDescription string

The email text.

roleName string

The name of a permission set specifying which actions clients are allowed to perform in the B2Core UI after obtaining this verification level.

POST[host]/api/v2/verifications/levels

curl --location --request POST 'https://host.name/api/v2/verifications/levels' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
  "index": 1,
  "caption": "Level 1",
  "description": "Level description",
  "visible": true,
  "default": true,
  "sustainable": false,
  "wizard": "DocumentsWizard",
  "levelId": 1,
  "mailDescription": "Mail Description",
  "roleName": "Level 1"
}'

Response

A response includes a Verification Level object providing information about the created verification level.

Update a verification level

Use this method to update a specified verification level.

Note

Instead of the method described below, you can use a similar method that uses the HTTP verbĀ PATCH.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Path parameters:

levelId required

The identifier of a verification level.

Body:

The following field values can be updated for a verification level:

index integer

The index assigned to a verification level.

The zero (0) index is always assigned to the default verification level. For the other verification levels, the index must be greater than zero.

wizard string

The name of a wizard used to run a verification procedure in the B2Core UI.

levelId integer

The identifier of a verification level.

caption string

The verification level name displayed in the B2Core UI.

description string

The verification level description displayed in the B2Core UI.

mailDescription string

The email text.

visible boolean

If true, a verification level is displayed to clients in the B2Core UI; otherwise, false.

default boolean

If true, a verification level is the default one and granted to all newly registered clients; otherwise, false.

roleName string

The name of a permission set specifying which actions clients are allowed to perform in the B2Core UI after obtaining this verification level.

documentGroups array

An array of string values specifying the groups of documents that clients must submit to obtain this verification level.

PUT[host]/api/v2/verifications/levels/{levelId}

curl --location --request PUT 'https://host.name/api/v2/verifications/levels/1' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
  "index": 1,
  "wizard": "DocumentsWizard",
  "levelId": 2,
  "caption": "Level 1",
  "description": " Level description",
  "mailDescription": "Mail description",
  "visible": true,
  "default": true,
  "roleName": "Level 1",
  "documentGroups": [
    "id_proof",
    "selfie"
  ]
}'

Response

A response includes a Verification Level object providing information about the verification level that was updated.

Delete a verification level

Use this method to remove a specified verification level.

Request

Header parameters:

  • Authorization: Bearer <token>

Path parameters:

levelId required

The identifier of a verification level.

DELETE[host]/api/v2/verifications/levels/{levelId}

curl --location --request DELETE 'https://host.name/api/v2/verifications/levels/1' \
--header 'Authorization: Bearer <token>'

Response

In case of success, no response body is returned.