KYC ПЛАТФОРМА

Формат ответа

Результат распознавания возвращается в виде JSON-объекта с типом документа и массивом распознанных полей.

Общая структура

{
  "documentType": {
    "type": "seafarers_identity_document",
    "countryCode": "rus",
    "version": "new"
  },
  "textFields": [
    {
      "name": "authority",
      "confidence": 0.6259458,
      "confidenceFlag": "true",
      "value": "ФГУ РАМБ / Е8 М08СОУУ ВРА"
    },
    {
      "name": "birthDate",
      "confidence": 0.6259458,
      "confidenceFlag": "true",
      "value": "17.08.1955"
    }
  ]
}

documentType

Поле Тип Описание Обязательность
type string Тип документа да
countryCode string Код страны по ISO 3166-1 alpha-3 да
version string Версия документа да

textFields

Поле Тип Описание Обязательность
name string Название распознанного поля да
confidence number Значение уверенности от 0 до 1 нет, настраивается для TenantId
confidenceFlag boolean Признак уверенного распознавания да
value string Распознанное значение поля да

По умолчанию сервис возвращает confidenceFlag. Числовое поле confidence можно включить для конкретного клиента.

Правило для confidenceFlag:

  • true – значение confidence больше или равно 0.6;
  • false – значение confidence меньше 0.6.

Возможные поля textFields

Набор параметров зависит от типа документа и может расширяться.

Атрибут Тип Описание
authority string Орган, выдавший документ, на родном языке
authorityEng string Орган, выдавший документ, на английском
mrzIssuer string Орган, выдавший документ, из MRZ
authorityCode string Код подразделения
birthDate date Дата рождения
mrzBirthDate date Дата рождения из MRZ
birthPlace string Место рождения на родном языке
birthPlaceEng string Место рождения на английском
fullMrz string Полностью распознанная MRZ-зона
gender string Пол
mrzGender string Пол из MRZ
categories string Категории, например для водительского удостоверения
issueDate date Дата выдачи документа
expiryDate date Дата окончания срока действия документа
mrzExpiryDate date Дата окончания срока действия из MRZ
name string Имя на родном языке
nameEng string Имя на английском
mrzName string Имя из MRZ
surname / lastName string Фамилия на родном языке
surnameEng / lastNameEng string Фамилия на английском
mrzLastName string Фамилия из MRZ
patronymic string Отчество
patronymicEng string Отчество на английском
number string Номер документа
mrzNumber string Номер документа из MRZ
residence string Место жительства
residenceEng string Место жительства на английском
nationality string Национальность
nationalityEng string Национальность на английском
mrzNationality string Национальность из MRZ
type string Тип документа
mrzDocTypeCode string Тип документа из MRZ
address string Адрес
organization string Организация
position string Должность или позиция, например в медкнижке
visaId string Номер визы

Что учитывать при обработке

  • Набор полей отличается для разных документов.
  • Клиентская система должна быть готова к появлению новых name в массиве textFields.
  • Не стоит жестко завязывать бизнес-логику только на порядок полей в массиве.