Трудовая книжка

Документы подтверждают сведения о трудовой деятельности работника.

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

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

---

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

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

Заголовки:

Content-Type: application/json

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

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

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

{
  "document_id": "s-12345"
}

---

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

Ключ	Описание
project_id	Название проекта (U_RATE_2)
token	Токен доступа (получается в разделе «Начало работы»)
machine_uid	Идентификатор устройства (получается в разделе «Начало работы»)
images	Список строк в формате base64 (файлов). Для СТД‑Р/СТД‑ПФР — один или несколько элементов массива (в зависимости от количества страниц документа)
process_info	Настройки обработки документа

Структура process_info

Ключ	Описание
key	Свободный ключ для разделения документов при загрузке и получении результатов. Если не указан, вместо него используется ключ type
type	Тип документа: STD_RPFR для СТД‑Р и СТД‑ПФР
options	Опции обработки документа

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

---

Пример запроса (Python) для отправки СТД‑Р/СТД‑ПФР

import requests
import base64

# Кодируем изображение документа в base64
with open("<путь до файла СТД-Р/СТД-ПФР>", "rb") as image_file:
    b64_std = 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_std],
        "process_info": [
            {
                "key": "STD1",
                "type": "STD_RPFR",
                "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-39157",
  "documents": [
    {
      "key": "STD1",
      "type": "STD_RPFR",
      "data": {
        "Gender": "F",
        "LastName": "Иванова",
        "FirstName": "Мария",
        "MiddleName": "Сергеевна",
        "BirthDate": "15.03.1985",
        "Records": [
          {
            "FireDate": "20.05.2022",
            "HireDate": "10.02.2018",
            "LastPosition": "Менеджер по продажам",
            "OrganizationName": "ООО «Пример»"
          },
          {
            "FireDate": "",
            "HireDate": "01.06.2023",
            "LastPosition": "Старший менеджер",
            "OrganizationName": "АО «Новый проект»"
          }
        ]
      },
      "metadata": {
        "confidences": {
          "Gender": 0.9995,
          "LastName": 0.9998,
          "FirstName": 0.9997,
          "MiddleName": 0.9996,
          "BirthDate": 0.9992,
          "Records[0].HireDate": 0.9985,
          "Records[0].FireDate": 0.9970,
          "Records[0].LastPosition": 0.9960,
          "Records[0].OrganizationName": 0.9950,
          "Records[1].HireDate": 0.9990
        },
        "verifications": {
          "status": 0,
          "status_text": "ок"
        }
      },
      "broken": false,
      "broken_reasons": [],
      "broken_reasons_ru": []
    }
  ]
}

---

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

Ключ	Тип	Описание
document_id	string	Номер документа в формате s-<номер документа>
documents	list	Список данных по каждому документу
documents[].key	string	Ключ, заданный при отправке документа для отслеживания (STD1)
documents[].type	string	Тип документа (STD_RPFR)
documents[].data	dictionary	Обработанные данные по каждому полю, содержит ключи полей и их определённые значения
Gender	string	Пол (M — мужской, F — женский)
LastName	string	Фамилия работника
FirstName	string	Имя работника
MiddleName	string	Отчество работника
BirthDate	string	Дата рождения (в формате ДД.ММ.ГГГГ)
Records	list	Массив записей о трудовой деятельности (только приём и увольнение)
Records[].FireDate	string	Дата увольнения (в формате ДД.ММ.ГГГГ), может быть пустой, если сотрудник ещё работает
Records[].HireDate	string	Дата приёма на работу (в формате ДД.ММ.ГГГГ)
Records[].LastPosition	string	Последняя должность в организации
Records[].OrganizationName	string	Название организации
metadata	dictionary	Содержит ключи метаданных
confidences	dictionary ({key: float})	Метаданные с точностью обработки по каждому полю — содержит ключи полей и значения уровня уверенности. Значения от 0.0000 до 0.9999, где чем значение больше, тем уверенность в результате выше. Максимальная уверенность — 0.9999
broken	boolean	Является ли документ бракованным
broken_reasons	list	Список причин брака (на английском языке)
broken_reasons_ru	list	Список причин брака (на русском языке)