Verification procedures

Use these methods to get client verification history and run verification procedures for the current client.

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

Get verification history

GET[host]/v2/my/verifications/{verificationId}

Get verification details

GET[host]/v2/my/verifications/wizard

Initialize a wizard for running a verification procedure

POST[host]/v2/my/verifications/

Run a verification procedure

Get verification history

Use this method to obtain a list of all operations of granting verification levels to the current client.

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

Request

Header parameters:

  • Authorization: Bearer <access_token>

Query parameters:

The following sorting parameter is available for this method:

createTime

The date and time when a verification level was granted to a client.

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

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

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

Response

id integer

The identifier of an operation of granting a verification level.

clientId integer

The client identifier.

currentLevel object

The details about a client’s current verification level:

Show object fields
id integer

The identifier of a verification level.

name string

The name of a verification level.

previuosLevel object

The details about a client’s previous verification level.

If a client is only granted the initial verification level so far, null is returned for the previous verification level.

Show object fields
id integer

The identifier of a verification level.

name string

The name of a verification level.

reason object

The details about the reason for granting a verification level.

Show object fields
name string

The reason why a verification level was granted.

userId integer

The identifier of an admin who granted a verification level.

createTime string

The date and time when a verification level was granted to a client.

RESPONSE EXAMPLE
{
  "total": 2,
  "data": [
    {
      "id": 75,
      "clientId": 222,
      "currentLevel": {
        "id": 2,
        "name": "Level 1"
      },
      "previousLevel": {
        "id": 1,
        "name": "Level 0"
      },
      "reason": {
        "name": "Application: 838"
      },
      "userId": "1",
      "createTime": "2022-01-01T00:00:00+00:00"
    },
    {
      "id": 186,
      "clientId": 222,
      "currentLevel": {
        "id": 1,
        "name": "Level 0"
      },
      "previousLevel": null,
      "reason": {
        "name": "created"
      },
      "userId": "1",
      "createTime": "2022-01-01T00:00:00+00:00"
    }
  ]
}

Get verification details

Use this method to obtain detailed information about a specified operation of granting a verification level to the current client.

To obtain a list of all operations of granting verification levels, use a separate method to get verification history.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Path parameters:

verificatioId required

The identifier of an operation of granting a verification level.

GET[host]/v2/my/verifications/{verificationId}

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

Response

id integer

The identifier of an operation of granting a verification level.

clientId integer

The client identifier.

currentLevel object

The details about a client’s current verification level:

Show object fields
id integer

The identifier of a verification level.

name string

The name of a verification level.

previuosLevel object

The details about a client’s previous verification level.

If a client is only granted the initial verification level so far, null is returned for the previous verification level.

Show object fields
id integer

The identifier of a verification level.

name string

The name of a verification level.

reason object

The details about the reason for granting a verification level.

Show object fields
name integer

The reason why a verification level was granted.

userId integer

The identifier of an admin who granted a verification level.

createTime string

The date and time when a verification level was granted to a client.

RESPONSE EXAMPLE
{
  "total": 1,
  "data": [
    {
      "id": 18,
      "clientId": 17,
      "currentLevel": {
        "id": 1,
        "name": "Level 0"
      },
      "previousLevel": null,
      "reason": {
        "name": "created"
      },
      "userId": 11,
      "createTime": "2022-01-01T00:00:00+00:00"
    }
  ]
}

Initialize a wizard for running a verification procedure

Use this method to initialize a wizard for running a verification procedure for the current client.

Request

Header parameters:

  • Authorization: Bearer <access_token>

GET[host]/v2/my/verifications/wizard

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

Response

code integer

An HTTP code specifying the current step in a progression of wizard pages:

  • HTTP code 200 for an intermediary step after which another page of a KYC form is displayed to a client

  • HTTP code 202 for a final wizard step signaling that verification was completed

data object

The details about document types required for obtaining this verification level. See the Document Type object to learn more.

done boolean

If true, wizard initialization has succeeded; otherwise, false.

uuid string

The universally unique identifier (UUID) assigned to a client verification procedure.

workflow string

A string value indicating the current stage of a verification procedure.

RESPONSE EXAMPLE
{
  "code": 202,
  "data": [
    "types": {
      "id": 2,
      "description": "Passport",
      "enabled": true,
      "example": "",
      "group": {}
    }
  ],
  "done": true,
  "uuid": "36f59381-5b54-48bd-a0c7-3b908c476732",
  "workflow": "B2B\\TCA\\Wizards\\Workflow\\TerminateWorkflow",
}

Run a verification procedure

After you have intialized a wizard for running a verification procedure, use this method to run the procedure for the current client.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Body:

documents object required

The data about the documents submitted for passing a verification procedure.

Show object fields
type

The identifier of a document type.

files

An array of string values specifying the paths to document files.

uuid string required

The universally unique identifier (UUID) obtained after initializing a wizard for running a verification procedure.

POST[host]/v2/my/verifications/

curl --location --request POST 'https://host.name/api/v2/my/verifications' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
  "data": {
    "documents": {
      "type": 1,
      "files": [
        "id_card,jpeg",
        "id_card_reverse_side.jpeg"
      ]
    },
    "uuid": "36f59381-5b54-48bd-a0c7-3b908c476732"
  }
}'

Response

code integer

An HTTP code specifying the current step in a progression of wizard pages:

  • HTTP code 200 for an intermediary step after which another page of a KYC form is displayed to a client

  • HTTP code 202 for a final wizard step signaling that verification was completed

data object

The details about submitted document types:

Show object fields
types array

An array of string values specifying the types of submitted documents.

done boolean

If true, a verification procedure has succeeded; otherwise, false.

uuid string

The universally unique identifier (UUID) assigned to a client verification procedure.

workflow string

A string value indicating the current stage of a verification procedure.

RESPONSE EXAMPLE
{
  "code": 202,
  "data": {
    "types": []
  },
  "done": true,
  "uuid": "36f59381-5b54-48bd-a0c7-3b908c476732",
  "workflow": "B2B\\TCA\\Wizards\\Workflow\\TerminateWorkflow",
}