Военный билет

Военный билет подтверждает статус военнослужащего и содержит сведения о его воинском учёте.

Пример изображения документа:

Документы для обработки должны быть закодированы в формат base64.

---

Отправка документа

Endpoint: POST https://api.beorg.ru/api/bescan/add_document

Заголовки:

Content-Type: application/json

Тело запроса:

{
  "project_id": "U_RATE_3",
  "images": ["<строка base64>"],
  "process_info": [
    {
      "key": "VNB1",
      "type": "VNB",
      "options": {
        "stages": ["verification"]
      }
    }
  ],
  "token": "<token>",
  "machine_uid": "<machine_uid>"
}

Пример ответа об успешной загрузке:

{
  "document_id": "s-12345"
}

---

Структура передаваемых данных

Ключ	Описание
project_id	Название проекта (U_RATE_3)
token	Токен доступа (получается в разделе «Начало работы»)
machine_uid	Идентификатор устройства (получается в разделе «Начало работы»)
images	Список строк в формате base64 (файлов). Для военного билета — один элемент массива (изображение документа)
process_info	Настройки обработки документа

Структура process_info

Ключ	Описание
key	Свободный ключ для разделения документов при загрузке и получении результатов. Если не указан, вместо него используется ключ type
type	Тип документа (VNB для военного билета)
options	Опции обработки документа

Для получения token, machine_uid и project_id обратитесь в подраздел «Начало работы».

---

Пример запроса (Python) для отправки военного билета

import requests
import base64

# Кодируем изображение документа в base64
with open("<путь до файла военного билета>", "rb") as image_file:
    b64_vnb = base64.b64encode(image_file.read()).decode()

# Отправляем запрос на API
r = requests.post(
    "https://api.beorg.ru/api/bescan/add_document",
    headers={"Content-Type": "application/json"},
    json={
        "project_id": project_id,
        "token": token,
        "machine_uid": machine_uid,
        "images": [b64_vnb],
        "process_info": [
            {
                "key": "VNB1",
                "type": "VNB",
                "options": {
                    "stages": ["verification"]  # только верификация данных
                }
            }
        ]
    }
)
print(r.json())  # выводим ответ сервера

---

Получение результатов

Endpoint: GET/POST https://api.beorg.ru/api/document/result/s-12345?token=<token>

Пример запроса для получения результатов (Python):

import requests

r = requests.get("https://api.beorg.ru/api/document/result/s-12345?token=<token>")
print(r.json())

---

Пример ответа по обработанному документу (военный билет)

{
  "document_id": "s-39152",
  "documents": [
    {
      "key": "VNB1",
      "type": "VNB",
      "data": {
        "Series": "АБ",
        "Number": "1234567",
        "Gender": "M",
        "LastName": "Сидоров",
        "FirstName": "Алексей",
        "MiddleName": "Петрович",
        "BirthDate": "25.08.1990",
        "IssuedBy": "Военный комиссариат г. Москвы",
        "Category": "офицеры",
        "MilitaryRank": "майор",
        "FullMilitarySpecialties": [
          {
            "FullMilitarySpecialty": "Командир мотострелкового взвода"
          }
        ],
        "MilitaryCommissariat": "Военный комиссариат Центрального административного округа г. Москвы"
      },
      "metadata": {
        "confidences": {
          "Series": 0.9995,
          "Number": 0.9998,
          "Gender": 0.9997,
          "LastName": 0.9996,
          "FirstName": 0.9994,
          "MiddleName": 0.9992,
          "BirthDate": 0.9985,
          "IssuedBy": 0.9970,
          "Category": 0.9965,
          "MilitaryRank": 0.9980,
          "FullMilitarySpecialties[0].FullMilitarySpecialty": 0.9950,
          "MilitaryCommissariat": 0.9940
        },
        "verifications": {
          "status": 0,
          "status_text": "ок"
        }
      },
      "broken": false,
      "broken_reasons": [],
      "broken_reasons_ru": []
    }
  ]
}

---

Описание ключей в ответе

Ключ	Тип	Описание
document_id	string	Номер документа в формате s-<номер документа>
documents	list	Список данных по каждому документу
documents[].key	string	Ключ, заданный при отправке документа для отслеживания (VNB1)
documents[].type	string	Тип документа (VNB)
documents[].data	dictionary	Обработанные данные по каждому полю, содержит ключи полей и их определённые значения
Series	string	Серия военного билета
Number	string	Номер военного билета
Gender	string	Пол (M — мужской, F — женский)
LastName	string	Фамилия военнослужащего
FirstName	string	Имя военнослужащего
MiddleName	string	Отчество военнослужащего
BirthDate	string	Дата рождения (в формате ДД.ММ.ГГГГ)
IssuedBy	string	Кем выдан военный билет
Category	string	Категория запаса (например, «офицеры», «солдаты»)
MilitaryRank	string	Воинское звание
FullMilitarySpecialties	list	Массив объектов с полными военными специальностями
FullMilitarySpecialties[].FullMilitarySpecialty	string	Полная военная специальность (например, «Командир мотострелкового взвода»)
MilitaryCommissariat	string	Военный комиссариат, ответственный за воинский учёт
metadata	dictionary	Содержит ключи метаданных
confidences	dictionary ({key: float})	Метаданные с точностью обработки по каждому полю — содержит ключи полей и значения уровня уверенности. Значения от 0.0000 до 0.9999, где чем значение больше, тем уверенность в результате выше. Максимальная уверенность — 0.9999
broken	boolean	Является ли документ бракованным
broken_reasons	list	Список причин брака (на английском языке)
broken_reasons_ru	list	Список причин брака (на русском языке)