B2Core API REST API The Back Office API Verification levels

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[host]/api/v2/verifications/levels/{levelId}/restrictions	Get a list of verification level restrictions
GET[host]/api/v2/verifications/levels/{levelId}/restrictions/{restrictionId}	Get verification level restriction details
POST[host]/api/v2/verifications/levels/{levelId}/restrictions	Add a verification level restriction
PUT[host]/api/v2/verifications/levels/{levelId}/restrictions/{restrictionId} PATCH[host]/api/v2/verifications/levels/{levelId}/restrictions/{restrictionId}	Update a verification level restriction
DELETE[host]/api/v2/verifications/levels/{levelId}/restrictions/{restrictionId}	Delete a verification level restriction

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.

Get a list of verification level restrictions

Use this method to obtain a list of restrictions added for a specified verification level.

Use a separate method to get verification level restriction details.

Request

Header parameters:

Authorization: Bearer <token>

Path parameters:

levelId required: The verification level identifier.

Query parameters:

The following filter parameter is available for this method:

name

The name of a verification level restriction. Possible value:

client_type — allows or forbids granting a verification level to specified client types.

Refer to the Query parameters section in the API Overview for details on applying filter and sorting parameters.

client_type — allows or forbids granting a verification level to specified client types

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

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

Response

A response includes an array of Verification Level Restriction objects providing information about the verification level restrictions matching the request parameters.

Get verification level restriction details

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

Use a separate method to get a list of verification level restrictions.

Request

Header parameters:

Authorization: Bearer <access_token>

Path parameters:

levelId integer required: The verification level identifier.
restrictionId integer required: The identifier of a verification level restriction.

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

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

Response

A response contains a Verification Level Restriction object providing information about the specified verification level restriction.

Add a verification level restriction

Use this method to add a new restriction for a specified verification level.

Request

Header parameters:

Authorization: Bearer <access_token>

Path parameters:

levelId required: The identifier of a verification level for which a restriction is to be added.

Body:

Specify the following parameters when adding a new verification level restriction:

name string required

The verification level restriction name.

isEnabled boolean required

If true, a restriction is enabled for a verification level; otherwise, false.

type string required

A string value specifying the type of a verification level restriction. Possible values:

allow
deny

ids array

An array of integer values identifying the client types to which a restriction applies.

POST[host]/api/v2/verifications/levels/{levelId}/restrictions

curl --location --request POST 'https://host.name/api/v2/verifications/levels/1/restrictions' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
  "name": "client_type",
  "isEnabled": true,
  "type": "allow",
  "ids": [
    "22",
    "3"
  ]
}'

Response

A response includes a Verification Level Restriction object providing information about the added verification level restriction.

Update a verification level restriction

Use this method to update a specified verification level restriction.

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 for which a restriction is to be updated.
restrictionId required: The identifier of a verification level restriction to be updated.

Body:

Specify the following parameters when updating a verification level restriction:

isEnabled boolean

If true, a restriction is enabled for a verification level; otherwise, false.

type string

A string value specifying the type of a verification level restriction. Possible values:

allow
deny

ids array

An array of integer values identifying the client types to which a restriction applies.

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

curl --location --request PATCH 'https://host.name/api/v2/verification/levels/1/restrictions/1' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
  "isEnabled": true,
  "type": "deny",
  "ids": [
    "22",
    "3"
  ]
}'

Response

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

Delete a verification level restriction

Use this method to remove a restriction for a specified verification level.

Request

Header parameters:

Authorization: Bearer <access_token>

Path parameters:

levelId required: The verification level identifier.
restrictionId required: The identifier of a verification level restriction to be removed.

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

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

Response

In case of success, no response body is returned.