Get a list of all KYC sessions

POST /kyc/sessions


Description

The method returns all user KYC sessions with their statuses and results. A token is required, see Authorization.


Request format

  • HTTP method: POST
  • URL: /kyc/sessions
  • Content type: application/json

Authorization

Pass the token in one of two ways:

  • the token: <jwt-token> header — a temporary JWT token obtained with user/login;
  • the token field in the request body — a permanent API token (UUID) from your account.

Without a token the request returns 401 access denied.


Request Body (JSON)

FieldTypeRequiredDescription
tokenstring—Permanent API token (UUID), if the token header is not sent
pageinteger❌Page number (for pagination)
pageSizeinteger❌Page size (for pagination)

Example Request (cURL)

curl -X POST "https://api.neuro-vision.ru/v1/kyc/sessions" -H "Content-Type: application/json" -H "token: <jwt-token>" -d '{"page": 1, "pageSize": 20}'

Example Answers

Success (200 OK)

{
  "status": "ok",
  "results": [
    {
      "sessionId": "00000000-0000-0000-0000-000000000000",
      "clientId": "00000000-0000-0000-0000-000000000000",
      "status": "success",
      "spent": 136.945,
      "results": [
        {
          "spent": 8.779,
          "status": "success",
          "type": "document",
          "docName": "GBR — Passport (2006)",
          "image": "url",
          "imageFull": "url",
          "checks": [
            {
              "caption": "fraud",
              "items": [
                {
                  "caption": "isEdited",
                  "status": "success"
                }
              ]
            }
          ],
          "ocr": {
            "fields": [
              {
                "conf": "high",
                "title": "Surname",
                "value": "DOE"
              }
            ],
            "status": "success"
          },
          "errors": [
            "[document] text fields not visible"
          ]
        }
      ],
      "createdAt": "2025-05-21T08:19:21.212Z",
      "isClientNew": false
    }
  ]
}

Error (400 invalid schema)

{
  "message": "invalid schema",
  "status": "error"
}

Error (400 no access)

{
  "message": "no access",
  "status": "error"
}