Судебный приказ

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

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

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

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

Заголовки:

Content-Type: application/json

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

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

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

{
  "document_id": "s-12345"
}

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

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

Структура `process_info`

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

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

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

import requests
import base64

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

# Отправляем запрос на API
r = requests.post(
    "https://api.beorg.ru/api/bescan/add_document",
    headers={"Content-Type": "application/json"},
    json={
        "campaign_id": campaign_id,
        "token": token,
        "machine_uid": machine_uid,
        "images": [b64_order],  # один файл — судебный приказ
        "process_info": [
            {
                "key": "PR",
                "type": "PR",
                "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-12345",
  "documents": [
    {
      "key": "PR",
      "type": "PR",
      "data": {
        "OrderNumber": "2-1000/2025",
        "OrderDate": "30.05.2025",
        "NameOfCollector": "ООО ПКО \"ДАТА\"",
        "Gender": "M",
        "DebtorLastName": "Иванов",
        "DebtorFirstName": "Иван",
        "DebtorMiddleName": "Иванович",
        "DebtorBirthDate": "01.01.2000",
        "LoanAgreementNumber": "001/1234567908",
        "LoanAgreementDate": "01.01.2024",
        "AmountOwed": "30000,01",
        "Duties": "2000,00",
        "TotalAmount": "32000,01"
      },
      "metadata": {
        "confidences": {
          "OrderNumber": 0.9995,
          "OrderDate": 0.9990,
          "NameOfCollector": 0.9985,
          "Gender": 0.9992,
          "DebtorLastName": 0.9997,
          "DebtorFirstName": 0.9996,
          "DebtorMiddleName": 0.9988,
          "DebtorBirthDate": 0.9991,
          "LoanAgreementNumber": 0.9980,
          "LoanAgreementDate": 0.9987,
          "AmountOwed": 0.9999,
          "Duties": 0.9993,
          "TotalAmount": 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	Ключ, заданный при отправке документа для отслеживания (`PR`)
`documents[].type`	string	Тип документа (`PR`)
`documents[].data`	dictionary	Обработанные данные по каждому полю — содержит ключи полей и их определённые значения
`OrderNumber`	string	Номер дела
`OrderDate`	string	Дата судебного приказа (в формате ДД.ММ.ГГГГ)
`NameOfCollector`	string	Наименование взыскателя
`Gender`	string	Пол должника (`M` — мужской, `F` — женский)
`DebtorLastName`	string	Фамилия должника
`DebtorFirstName`	string	Имя должника
`DebtorMiddleName`	string	Отчество должника
`DebtorBirthDate`	string	Дата рождения должника (в формате ДД.ММ.ГГГГ)
`LoanAgreementNumber`	string	Номер договора займа
`LoanAgreementDate`	string	Дата договора займа (в формате ДД.ММ.ГГГГ)
`AmountOwed`	string	Сумма задолженности (в рублях, с копейками через запятую)
`Duties`	string	Сумма госпошлины (в рублях, с копейками через запятую)
`TotalAmount`	string	Общая сумма к взысканию (в рублях, с копейками через запятую)
`metadata`	dictionary	Содержит ключи метаданных
`confidences`	dictionary (`{key: float}`)	Метаданные с точностью обработки по каждому полю — содержит ключи полей и значения уровня уверенности. Значения от `0.0000` до `0.9999`, где чем значение больше, тем уверенность в результате выше. Максимальная уверенность — `0.9999`
`broken`	boolean	Является ли документ бракованным
`broken_reasons`	list	Список причин брака (на английском языке)
`broken_reasons_ru`	list	Список причин брака (на русском языке)