Патент

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

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

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

---

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

import requests
import base64

# Кодируем изображение патента в base64
with open("<путь до файла Трудового патента для иностранца>", "rb") as image_file:
    b64_patent = 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_patent],  # один файл — трудовой патент
        "process_info": [
            {
                "key": "PAT1",
                "type": "PAT",
                "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-39183",
  "documents": [
    {
      "key": "PAT1",
      "type": "PAT",
      "data": {
        "Series1": "77 23",
        "Number1": "123456",
        "Gender": "M",
        "LastName": "Абдуллаев",
        "FirstName": "Али",
        "MiddleName": "Хасанович",
        "BirthDate": "15.05.1985",
        "Citizenship": "Республика Узбекистан",
        "IdentityDocument": "Паспорт гражданина Республики Узбекистан",
        "INN": "771234567890",
        "Post": "Строитель",
        "Area": "г. Москва",
        "IssuedBy": "ГУ МВД России по г. Москве",
        "IssueDate": "20.01.2024",
        "Series2": "77 23",
        "Number2": "123456"
      },
      "metadata": {
        "confidences": {
          "Series1": 0.9995,
          "Number1": 0.9998,
          "Gender": 0.9990,
          "LastName": 0.9997,
          "FirstName": 0.9996,
          "MiddleName": 0.9985,
          "BirthDate": 0.9992,
          "Citizenship": 0.9980,
          "IdentityDocument": 0.9975,
          "INN": 0.9999,
          "Post": 0.9993,
          "Area": 0.9994,
          "IssuedBy": 0.9991,
          "IssueDate": 0.9990,
          "Series2": 0.9995,
          "Number2": 0.9998
        }
      },
      "verifications": {
        "status": 0,
        "status_text": "ок",
        "bad_fields": []
      },
      "broken": false,
      "broken_reasons": [],
      "broken_reasons_ru": []
    }
  ]
}

---

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

Ключ	Тип	Описание
document_id	string	Номер документа в формате s-<номер документа>
documents	list	Список данных по каждому документу
documents[].key	string	Ключ, заданный при отправке документа для отслеживания (PAT1)
documents[].type	string	Тип документа (PAT)
documents[].data	dictionary	Обработанные данные по каждому полю — содержит ключи полей и их определённые значения
Series1	string	Серия 1 стороны документа
Number1	string	Номер 1 стороны документа
Gender	string	Пол (M — мужской, F — женский)
LastName	string	Фамилия
FirstName	string	Имя
MiddleName	string	Отчество
BirthDate	string	Дата рождения (в формате ДД.ММ.ГГГГ)
Citizenship	string	Гражданство
IdentityDocument	string	Тип удостоверяющего документа
INN	string	ИНН (Идентификационный номер налогоплательщика)
Post	string	Должность
Area	string	Территория действия патента
IssuedBy	string	Кем выдан документ
IssueDate	string	Дата выдачи документа (в формате ДД.ММ.ГГГГ)
Series2	string	Серия 2 стороны документа
Number2	string	Номер 2 стороны документа
metadata	dictionary	Содержит ключи метаданных
confidences	dictionary ({key: float})	Метаданные с точностью обработки по каждому полю — содержит ключи полей и значения уровня уверенности. Значения от 0.0000 до 0.9999, где чем значение больше, тем уверенность в результате выше. Максимальная уверенность — 0.9999
broken	boolean	Является ли документ бракованным
broken_reasons	list	Список причин брака (на английском языке)
broken_reasons_ru	list	Список причин брака (на русском языке)