Перейти к содержанию

Удостоверение гражданина, подлежащего призыву на военную службу

Документ, выдаваемый гражданам Российской Федерации при прохождении комиссии по постановке граждан на воинский учёт. При призыве гражданина на военную службу или зачислении в запас данное удостоверение изымается и выдаётся военный билет.

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

Документы для обработки должны быть закодированы в формат 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": "PRSV1",
      "type": "PRSV",
      "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 Тип документа (PRSV для приписного свидетельства)
options Опции обработки документа

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


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

import requests
import base64

# Кодируем изображение приписного свидетельства в base64
with open("<путь до файла Приписного свидетельства>", "rb") as image_file:
    b64_prsv = 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_prsv],  # один файл — приписное свидетельство
        "process_info": [
            {
                "key": "PRSV1",
                "type": "PRSV",
                "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-39182",
  "documents": [
    {
      "key": "PRSV1",
      "type": "PRSV",
      "data": {
        "Series": "АБ",
        "Number": "1234567",
        "Gender": "M",
        "LastName": "Иванов",
        "FirstName": "Пётр",
        "MiddleName": "Сергеевич",
        "BirthDate": "15.03.2005",
        "IssuedBy": "Военный комиссариат г. Москвы",
        "Category": "А",
        "AttitudeToMilitaryRegistration": "состоит",
        "RegistrationDate": "20.02.2022",
        "MilitaryCommissariat": "Военный комиссариат Центрального административного округа г. Москвы",
        "PostponementDate": "31.12.2025"
      },
      "metadata": {
        "confidences": {
          "Series": 0.9995,
          "Number": 0.9998,
          "Gender": 0.9990,
          "LastName": 0.9997,
          "FirstName": 0.9996,
          "MiddleName": 0.9985,
          "BirthDate": 0.9992,
          "IssuedBy": 0.9980,
          "Category": 0.9975,
          "AttitudeToMilitaryRegistration": 0.9993,
          "RegistrationDate": 0.9991,
          "MilitaryCommissariat": 0.9988,
          "PostponementDate": 0.9982
        },
        "verifications": {
          "status": 0,
          "status_text": "ок",
          "bad_fields": []
        }
      },
      "broken": false,
      "broken_reasons": [],
      "broken_reasons_ru": []
    }
  ]
}

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

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