# API-запросы

{
  "token": "_act-b8ebfb63-5f24-4b89-9c08-5bbabeec986e",
  "userId": "JamesBond007"
}

{
  "description": "Error analyzing file, unsupported format or corrupted file",
  "code": 400,
  "correlationId": "req-5fd59b09-7f5e-41cd-a86b-38a4e6d57e08",
  "errorCode": 1004, // Может отсутствовать
  "errorName": "corrupted-file" // Может отсутствовать
}

{
    "id": "5f80e6b7155a6336271e4677", //applicantId
    "createdAt": "2020-10-09 22:39:51",
    "clientId": "cyberityClient",
    "inspectionId": "5f80e6b7155a6336271e4678",
    "externalUserId": "someUniqueUserId",
    "fixedInfo": {
        "placeOfBirth": "London",
        "country": "GBR"
    },
    "email": "john.smith@cyberity.ru",
    "phone": "+449112081223",
    "requiredIdDocs": {
        "excludedCountries": [
            "PRK"
        ],
        "docSets": [
            {
                "idDocSetType": "IDENTITY",
                "types": [
                    "PASSPORT",
                    "DRIVERS",
                    "ID_CARD",
                    "RESIDENCE_PERMIT"
                ]
            },
            {
                "idDocSetType": "SELFIE",
                "types": [
                    "SELFIE"
                ],
                "videoRequired": "disabled"
            }
        ]
    },
    "review": {
        "reprocessing": false,
        "createDate": "2020-10-09 22:39:51+0000",
        "reviewStatus": "init"
    },
    "type": "individual"
}

{
    "id": "5f80e6b7155a6336271e4677",
    "createdAt": "2020-10-09 22:47:58",
    "clientId": "cyberityClient",
    "inspectionId": "5f80e6b7155a6336271e4678",
    "externalUserId": "someUniqueUserId",
    "info": {
        "firstName": "John",
        "firstNameEn": "John",
        "lastName": "Smith",
        "lastNameEn": "Smith",
        "dob": "2000-03-04",
        "placeOfBirth": "London",
        "placeOfBirthEn": "London",
        "country": "GBR",
        "phone": "+449112081223"
    },
    "email": "john.smith@cyberity.ru",
    "requiredIdDocs": {
        "docSets": [
            {
                "idDocSetType": "IDENTITY",
                "types": [
                    "PASSPORT",
                    "DRIVERS",
                    "ID_CARD",
                    "RESIDENCE_PERMIT"
                ]
            },
            {
                "idDocSetType": "SELFIE",
                "types": [
                    "SELFIE"
                ],
                "videoRequired": "disabled"
            },
            {
                "idDocSetType": "PROOF_OF_RESIDENCE",
                "types": [
                    "UTILITY_BILL"
                ]
            }
        ]
    },
    "review": {
        "reprocessing": false,
        "levelName": "kyc-with-poa",
        "createDate": "2020-10-09 22:47:58+0000",
        "reviewStatus": "init"
    },
    "type": "individual"
}

{
  "idDocType": "PASSPORT",
  "country": "USA",
  "errors": [ "dataNotReadable" ] // will be absent in case of X-Return-Doc-Warnings not having value of "true"
}

{
  "idDocType": "PASSPORT",
  "country": "GBR",
  "issuedDate": "2015-01-02",
  "number": "40111234567",
  "dob": "2000-02-01",
  "placeOfBirth": "London"
}

{
  "id": "5b594ade0a975a36c9349e66",
  "createdAt": "2020-06-24 05:05:14",
  "clientId": "ClientName",
  "inspectionId": "5b594ade0a975a36c9379e67",
  "externalUserId": "SomeExternalUserId",
  "fixedInfo": {
    "firstName": "Chris",
    "lastName": "Smith"
  },
  "info": {
    "firstName": "CHRISTIAN",
    "firstNameEn": "CHRISTIAN",
    "lastName": "SMITH",
    "lastNameEn": "SMITH",
    "dob": "1989-07-16",
    "country": "DEU",
    "idDocs": [
      {
        "idDocType": "ID_CARD",
        "country": "DEU",
        "firstName": "CHRISTIAN",
        "firstNameEn": "CHRISTIAN",
        "lastName": "SMITH",
        "lastNameEn": "SMITH",
        "validUntil": "2028-09-04",
        "number": "LGXX359T8",
        "dob": "1989-07-16",
        "mrzLine1": "IDD<<LGXX359T88<<<<<<<<<<<<<<<",
        "mrzLine2": "8907167<2809045D<<<<<<<<<<<<<8",
        "mrzLine3": "SMITH<<CHRISTIAN<<<<<<<<<<<<<<"
      }
    ]
  },
  "agreement": { //present when WebSDK was initialized with Agreement screen enabled
    "createdAt": "2020-06-24 04:18:40",
    "source": "WebSDK",
    "targets": [
      "By clicking Next, I accept [the Terms and Conditions](https://www.cyberity.ru/consent-to-personal-data-processing/)",
      "I agree to the processing of my personal data, as described in [the Consent to Personal Data Processing](https://cyberity.ru/consent-to-personal-data-processing/)"
    ]
  },
  "email": "christman1@gmail.com",
  "applicantPlatform": "Android",
  "requiredIdDocs": {
    "docSets": [
      {
        "idDocSetType": "IDENTITY",
        "types": [
          "PASSPORT",
          "ID_CARD"
        ]
      },
      {
        "idDocSetType": "SELFIE",
        "types": [
          "SELFIE"
        ]
      }
    ]
  },
  "review": {
    "elapsedSincePendingMs": 115879,
    "elapsedSinceQueuedMs": 95785,
    "reprocessing": true,
    "levelName": "basic-kyc",
    "createDate": "2020-06-24 05:11:02+0000",
    "reviewDate": "2020-06-24 05:12:58+0000",
    "reviewResult": {
      "reviewAnswer": "GREEN"
    },
    "reviewStatus": "completed"
  },
  "lang": "de",
  "type": "individual"
}

{
  "ok": 1
}

{
  "id": "5bb8563c0a975a5e6b322ecc",
  "createdAt": "2018-10-06 06:29:16",
  "clientId": "cyberityClient",
  "inspectionId": "5bb8563c0a975a5e6b322ecd",
  "externalUserId": "someClientUserId",
  "info": {
    "firstName": "John",
    "lastName": "Smith",
    "dob": "2000-03-04",
    "placeOfBirth": "London",
    "country": "GBR",
    "phone": "+449112081223"
  },
  "requiredIdDocs": {
    "docSets": [
      {
        "idDocSetType": "IDENTITY",
        "types": ["PASSPORT", "ID_CARD", "DRIVERS"]
      }
    ]
  },
  "review": {
    "createDate": "2018-12-10 16:26:45+0000",
    "reviewDate": "2018-12-10 16:27:29+0000",
    "reviewResult": {
      "reviewAnswer": "RED",
      "rejectLabels": ["BLOCKLIST"],
      "reviewRejectType": "FINAL"
    },
    "reviewStatus": "completed"
  }
}

{
  "ok": 1
}

{
  "ok": 1
}

{
  "id": "5e9ad53d0a975a656d67e4d0",
  "createdAt": "2020-04-18 10:23:57",
  "inspectionId": "5e9ad53d0a975a656d67e4d1",
  "externalUserId": "1983114",
  "email": "new@email.nz",
  "requiredIdDocs": {
    "docSets": [
      {
        "idDocSetType": "IDENTITY",
        "types": [
          "ID_CARD",
          "PASSPORT",
          "DRIVERS"
        ]
      },
      {
        "idDocSetType": "SELFIE",
        "types": [
          "SELFIE"
        ],
        "videoRequired": "liveness"
      }
    ]
  },
  "review": {
    "createDate": "2020-04-18 10:25:53+0000",
    "expireDate": "2020-04-18 10:40:53+0000",
    "reviewStatus": "init"
  },
  "lang": "en",
  "type": "individual"
}

{
  "id": "5f0864923cc18175d35bf1aa",
  "createdAt": "2020-07-10 12:52:34",
  "key": "QJZKBRIYUSBBWY",
  "clientId": "yourclientid",
  "inspectionId": "5f0864923cc18175d35bf1ab",
  "externalUserId": "someClientUserId",
  "info": {
    "firstName": "John",
    "lastName": "Snow"
  },
  "requiredIdDocs": {
    "docSets": [{
      "idDocSetType": "IDENTITY",
      "types": [
        "PASSPORT",
        "ID_CARD",
        "DRIVERS"
      ]
    }]
  },
  "review": {
    "elapsedSincePendingMs": 100,
    "elapsedSinceQueuedMs": 50,
    "createDate": "2019-10-21 08:25:32+0000",
    "reviewDate": "2019-10-21 08:25:36+0000",
    "reviewResult": {
      "moderationComment": "",
      "clientComment": "",
      "reviewAnswer": "GREEN"
    },
    "reviewStatus": "completed",
    "levelName": "basic-kyc-level"
  },
  "lang": "en",
  "type": "individual"
}

{
  "riskLevel": "high",
  "entries": [
    {
      "id": "5eda11960a975a6de48b5c08",
      "createdAt": "2020-06-05 09:34:14",
      "comment": "Danger!",
      "riskLevel": "high"
    }
  ]
}

{
    "ok": 1
}

{
  "ok": 1
}

{
    "reviewId": "Qdelc",
    "attemptId": "IYLzU",
    "attemptCnt": 1,
    "elapsedSincePendingMs": 61562,
    "elapsedSinceQueuedMs": 10855,
    "reprocessing": true,
    "levelName": "KYC",
    "levelAutoCheckMode": null,
    "createDate": "2025-07-04 11:06:16+0000",
    "reviewDate": "2025-07-04 11:07:18+0000",
    "reviewResult": {
        "reviewAnswer": "RED",
        "rejectLabels": [
            "UNSATISFACTORY_PHOTOS"
        ],
        "reviewRejectType": "RETRY",
        "buttonIds": [
            "badPhoto",
            "badPhoto_dataNotVisible"
        ]
    },
    "reviewStatus": "completed",
    "priority": 0
}

{
  "IDENTITY": {
   // a step identifier
    "reviewResult": {
    // if exists, that means that a document was uploaded
      "moderationComment": "Please upload a photo of the front of your ID card.",
      "reviewAnswer": "RED"
    },
    "country": "LVA", // document country
    "idDocType": "ID_CARD", // specific document type for the step
    "imageIds": [122352326,34246467], // image IDs that represent a document
    //If imageIds array contains more than one element the first one would be front side and others - back sides
    "imageReviewResults": {
      "34246467": {
        "reviewAnswer": "GREEN"
      },
      "122352326": {
        "moderationComment": "Please upload a photo of the front of your ID card.", // A human-readable comment that can be shown to your end user
        "clientComment": "One side of the document is missing.",  //A human-readable comment that should not be shown to an end user, and is meant to be read by a client
        "reviewAnswer": "RED",
        "rejectLabels": ["DOCUMENT_PAGE_MISSING","FRONT_SIDE_MISSING"],
        "reviewRejectType": "RETRY"
      }
    }
  },
  "SELFIE": {
    "reviewResult": {
      "reviewAnswer": "GREEN"
    },
    "country": "LVA",
    "idDocType": "SELFIE",
    "imageIds": [181314576],
    "imageReviewResults": {
      "181314576": {
        "reviewAnswer": "GREEN"
      }
    }
  }
}

{
  "spam": [], //Загружено слишком много изображений
  "redCrypto": [], //Криптотранзакции с высоким рисковым рейтингом
  "blackCrypto": [], //Переданы некорректные параметры для проверки криптотранзакции
  "applicantDataMismatch": [],
  "regulationsViolations": [
    "age", //Возраст не соответствует требованиям
    "duplicate", //У пользователя уже есть одобренная анкета
    "wrongRegion", //Регион или страна входит в список исключённых
    "foreigner", //Страна проживания не совпадает со страной банковской карты
    "crime", //У пользователя есть судимости
    "poorDrivingSkills", //Водительский стаж не соответствует требованиям
    "poorFinancialPosition", //Финансовое положение не соответствует требованиям
    "fines", //Сумма штрафов не соответствует требованиям
    "deprivations", //Обнаружены факты изъятия документов
    "notAllowedToDrive", //У пользователя нет права на вождение (специальная настройка)
    "diffDocPersons", //Предоставлены документы разных людей
    "inconsistency", //Предоставленная информация не совпадает с данными в документах
    "docNotFound", //Данные документа не найдены в базах данных
    "countriesMismatch", //Страна проживания не совпадает со страной банковской карты
    "riskBankCard", //Банковская карта с высоким уровнем риска
    "highRiskProfile", //Высокий поведенческий риск
    "spam", //Загружено слишком много изображений
    "blacklist" //Данные пользователя найдены в глобальном блок-листе
    "blocklist" //Данные пользователя найдены в вашем локальном блок-листе
  ],
  "automaticRegulations": [
    "wrongRegion", //Регион или страна входит в список исключённых
    "wrongProvince", //Провинция входит в список исключённых
    "wrongCountry" //Страна входит в список исключённых
  ],
  "specificClientRequirements": [
    "age", //Возраст не соответствует требованиям
    "notAllowedToDrive", //У пользователя нет права на вождение
    "anotherDocument" //Документ не поддерживается по индивидуальным требованиям
  ],
  "kycBlacklisted": [
    "compromisedDoc", //Использован украденный или утекший документ
    "physicalForgery", //Фото физически подделанного документа
    "digitalForgery", //Фото документа с цифровыми правками
    "creditCardFraud", //Мошенничество с банковской картой
    "anotherPersonsDoc", //Использован документ другого человека
    "multipleRegistration", //Повторная регистрация
    "forcedRegistration", //Регистрация была выполнена под давлением
    "financialFraud", //Финансовое мошенничество
    "clientRules", //Индивидуальная причина отказа (задано клиентом)
    "virtualCam" //Во время проверки использовалась виртуальная камера
  ],
  "dataMismatch": [
    "fullName", //Полное имя в профиле отсутствует или указано с ошибкой
    "dateOfBirth", //Дата рождения в профиле отсутствует или указана с ошибкой
    "address", //Проблема с адресом в профиле
    "inconsistency" //Имя держателя банковской карты не совпадает с именем в документе
  ],
  "fraudulentPatterns": [
    "selfieMismatch", //Селфи не совпадает с фото в документе
    "fake", //Подозрение на мошенничество
    "blacklist", //Аккаунт подозревается в подделке — найден в глобальном блок-листе
    "blocklist", //Аккаунт подозревается в подделке — найден в вашем локальном блок-листе
    "highRiskProfile", //Высокий поведенческий риск
    "physicalForgery", //Загружена физически подделанная копия документа
    "wantedDocument", //Документ находится в списке разыскиваемых или утерянных
    "livenessForced", //Обнаружены следы принуждения пользователя
    "deepFake" //Попытка обойти проверку с помощью дипфейка
  ],
  "moreDocs": [
    "individual", //Не предоставлены все обязательные документы
    "additionalPages" //Требуются дополнительные страницы документа
  ],
  "compromisedPersons": [ //Обнаружено совпадение с персоной из списков AML (подозрение подтверждено)
    "pep",
    "sanctionList",
    "criminalRecords",
    "adverseMedia"
  ],
  "company": [
    "moreDocs", //Не предоставлены все обязательные документы компании
    "notDeterminedBeneficiaries", //Не удалось определить бенефициаров
    "controlStructureIsNotEstablished",
    "notValidatedBeneficiaries", //Бенефициары не прошли проверку
    "notDeterminedRepresentatives", //Не удалось определить представителей
    "notValidatedRepresentatives", //Представители не прошли проверку
    "additionalInfo" //Требуется дополнительная информация о компании
  ],
  "checks": [
    "noInfoForChecks"
  ],
  "additionalPages": [ //Требуются дополнительные страницы или стороны документа
    "anotherSide",
    "frontSideId",
    "backSideId",
    "frontSideDl",
    "backSideDl",
    "frontSideTranslation",
    "backSideTranslation",
    "frontSideRp",
    "backSideRp",
    "mainPageId",
    "frontSideForeignId",
    "backSideForeignId",
    "localId",
    "registrationStamp",
    "2-3_IdDocPages",
    "4-5_IdDocPages",
    "6-7_IdDocPages",
    "8-9_IdDocPages",
    "10-11_IdDocPages",
    "12-13_IdDocPages",
    "30-31_IdDocPages",
    "selfie",
    "passport",
    "proofOfAddress",
    "birthCertificate"
  ],
  "badDocument": [ //Предоставлен неподходящий документ
    "expiredId", //Истек срок действия документа
    "invalidId", //Недействительный документ
    "damagedId", //Документ повреждён
    "notFullNameOrDob", //В документе отсутствует полное имя и/или дата рождения
    "withoutFace", //Лицо в документе плохо видно
    "dataNotVisible", //Необходимые данные документа не видны
    "copyOfIdDoc", //Предоставлена копия документа
    "noStamp", //Печать не видна
    "wrongType", //TТип документа не поддерживается или не принимается
    "unsigned", //Документ не подписан
    "needTranslation", //Требуется перевод документа на английский язык
    "fake", //Недостоверное удостоверение личности
    "expirationDate", //Документ должен быть действителен минимум 1 месяц после загрузки
    "inconsistency" //Имя владельца банковской карты не совпадает с именем в документе
  ],
  "badPhoto": [
    "lowQuality", //Низкое качество изображения
    "screenshot", //Загружен скриншот
    "blackAndWhite", //Требуется цветное фото или скан
    "imageEditor", //Обнаружено использование графического редактора
    "incomplete", //Все углы документа должны быть видны
    "notAPhoto", //Фото было преобразовано в PDF
    "idOnly", //Требуется только документ, удостоверяющий личность
    "faceNotFound",
    "fullDoublePage", //Разворот документа виден не полностью
    "frontSideId", //Требуется главный разворот документа
    "backSideId", //Требуется обратный разворот документа
    "frontSideDl", //Требуется лицевая сторона ВУ
    "backSideDl", //Требуется обратная сторона ВУ
    "mainIdDocPage",
    "2-3_IdDocPages",
    "4-5_IdDocPages",
    "6-7_IdDocPages",
    "frontSideNationalDl",
    "backSideNationalDl",
    "dataNotVisible", //Необходимые данные документа не видны
    "pdfFonts", //Обнаружены следы редактирования изображения
    "sticker", //Личная информация скрыта с помощью графического редактора
    "cardRequirements"
  ],
  "proofOfIdentity": [
    "passport", //Запрошен паспорт
    "idCard", //Запрошена ID-карта
    "drivingLicence", //Запрошено водительское удостоверение
    "residencePermit" //Запрошен вид на жительство
  ],
  "selfie": [
    "lowQuality", //Запрошено новое селфи с лучшим качеством изображения
    "selfieWithId", //Запрошено селфи с удостоверением личности
    "selfieWithPassport",
    "selfieWithDl",
    "selfieWithAnotherId", //Запрошено селфи с другим документом
    "selfieWithNewId", //Запрошено селфи с новым удостоверением личности
    "selfiePaper", //Запрошено селфи с листом бумаги с сегодняшней датой
    "blackAndWhite", //Запрошено цветное фото
    "badFaceComparison", //Плохое сравнение лиц
    "avatarIssue",
    "freshSelfie", //Запрошено актуальное селфи с текущей датой.
    "selfieLiveness", //Запрошена повторная проверка на живость лица
    "customIssue"
  ],
  "videoSelfie": [
    "lowQuality",
    "videoWithoutFace",
    "spokenPhraseMismatch",
    "videoWithId", //Запрошено видео-селфи с документом
    "videoWithAnotherId",
    "videoWithNewId"
  ],
  "profileImage": [
    "lowQuality",
    "wrongPhoto"
  ],
  "proofOfAddress": [
    "fullName", //Запрошено подтверждение адреса с полным именем пользователя
    "fullAddress", //Требуется документ с подходящей датой выдачи
    "issueDate", //Запрошен подходящий документ, подтверждающий адрес
    "listOfDocs", //Истек срок действия документа
    "expirationDate",
    "dataMismatch",
    "sameDoc", //Один и тот же документ был предоставлен как удостоверение личности и как подтверждение адреса
    "certifiedForm", //Запрошена заверенная форма документа, подтверждающего адрес
    "notEnoughData",
    "countryMismatch"
  ],
  "proofOfPayment": [
    "bankCard", //Высокорисковая банковская карт
    "bankStatement", //Запрошена выписка из банка
    "e-wallet", //Запрошено подтверждение электронного кошелька
    "wireTransfer", //Запрошено подтверждение банковского перевода
    "bankAccount", //Отсутствует номер счёта
    "dataMismatch"
  ],
  "bankCard": [
    "fullNameIssue", //Карта без имени пользователя
    "highRisk",
    "expirationDate",
    "badCard",
    "specificCard",
    "noCard"
  ],
  "bankStatement": [
    "fullNameIssue", //Запрошена выписка с полным именем пользователя
    "numberMismatch", //Номер карты в выписке не совпадает с предоставленной картой
    "invalidIssueDate", //Запрошена выписка с подходящей датой выдачи
    "notEnoughData" //Отсутствуют номер счёта или номер карты
  ],
  "differentDocs": [
    "identityDoc",
    "paymentMethodDoc"
  ],
  "graphicEditor": [
    "frontSide",
    "backSide",
    "selfie"
  ],
  "fake": [
    "printed", //Распечатанная копия документа
    "editedMrz", //Отредактированные MRZ-данные
    "blacklisted", //Документ или способ оплаты в чёрном списке
    "editedId", //Отредактированы основные данные документа
    "forgedId", //Поддельный физический документ
    "webId", //Образец документа из интернета
    "fakePoa", //Недостоверное подтверждение адреса
    "editedPoa", //Отредактированные данные адреса
    "fakeSelfie" //Селфи с поддельным документом
  ],
  "paymentsIssues": [
    "bankStatement",
    "bankBook",
    "emailScreen",
    "webScreen",
    "dataScreen"
  ],
  "livenessIssues": [
    "livenessDifferentPeople", //Во время проверки на живость обнаружены разные лица
    "livenessBypassAttempt" //Попытка обойти проверку на живость
  ]
}

{
  "list": {
    "items": [
      {
        "id": "5eebac3dd5ea480a98d51b40",
        "applicantId": "5eeb914604f940217bdbad05",
        "key": "TFRRN1THCATLDW",
        "imagesStates": {
          "104037333": { //imageId
            "state": {
              "badPhoto": { //Unsatisfactory photo was submitted
                "value": true //buttonId is active
              },
              "badPhoto_imageEditor": { //Graphic editing software usage was detected
                "value": true
              }
            }
          },
          "885188054": {
            "state": {
              "badPhoto": {
                "value": true
              },
              "badPhoto_imageEditor": {
                "value": true
              }
            }
          },
          "1777063415": {
            "state": {
              "badPhoto": { //Unsatisfactory photo was submitted
                "value": true
              },
              "badPhoto_incomplete": { //Not all document edges are visible
                "value": true
              }
            }
          },
          "1054210547": {
            "state": {
              "badPhoto": {
                "value": true
              },
              "badPhoto_incomplete": {
                "value": true
              }
            }
          },
          "1234193281": {
            "state": {
              "badPhoto": {
                "value": true
              },
              "badPhoto_incomplete": {
                "value": true
              }
            }
          },
          "484169174": {
            "state": {
              "badPhoto": {
                "value": true
              },
              "badPhoto_imageEditor": {
                "value": true
              }
            }
          },
          "741138243": {
            "state": {
              "badPhoto": {
                "value": true
              },
              "badPhoto_incomplete": {
                "value": true
              }
            }
          },
          "2118922684": {
            "state": {
              "badPhoto": {
                "value": true
              },
              "badPhoto_imageEditor": {
                "value": true
              }
            }
          },
          "1719337639": {
            "state": {
              "badPhoto": {
                "value": true
              },
              "badPhoto_incomplete": {
                "value": true
              }
            }
          }
        },
        "applicantState": {
          "regulationsViolations_wrongRegion": { //User is from excluded region/country
            "value": false //buttonId is inactive
          },
          "regulationsViolations": {
            "value": false
          },
          "dataMismatch": {},
          "dataMismatch_address": {
            "value": false
          },
          "regulationsViolations_duplicate": {
            "value": false
          }
        }
      }
    ],
    "totalItems": 1
  }
}

{
  "ok": 1
}

{
  "token": "_act-460a698b-d2bc-4cbc-9456-5f36fee38083",
  "forClientId": "CoolCoinLtd"
}

{
    // Applicant in service Y
    "id": "5d08a63239b79354a2ebaa1d",
    "createdAt": "2019-06-18 10:52:02",
    "clientId": "CoolCoinLtd",
    ...
}

{
  "digest": "f6e92ffe371718694d46e28436f76589312df8db"
}