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

Изображение документа "Судебный приказ"

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

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

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

Структура запроса:

url: https://api.beorg.ru/api/bescan/add_document
method: POST
headers:
    Content-Type: application/json

body:
{
    "campaign_id": "U_RATE_2",
    "images": ["<строка base64>"],
    "process_info": [настройки обработки]
    "token": token,
    "machine_uid": machine_uid
}

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

{
    "document_id": "s-12345"
}

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

Ключ	Описание
campaign_id	название проекта
token	токен доступа
machine_uid	идентификатор устройства
images	список из строк base64 (файлов)
process_info	настройки обработки

Структура prosess_info:

Ключ	Описание
key	свободный ключ для разделения документов при загрузке и получении результатов если не указан вместо него используется ключ type
type	тип документа
options	опции обработки документа

⚠️ Для получения token и machine_uid обратитесь в подраздел "Начало работы"

Python

import requests
import base64

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

r = requests.post(
    "https://api.beorg.ru/api/bescan/add_document",
    headers={"Content-Type": "application/json"},
    json={
        "campaign_id": "U_RATE_3",
        "token": token,
        "machine_uid": machine_uid,
        "images": [b64],
        "process_info": [
            {
                "key": "PR",
                "type": "PR",
            }
        ],
    },
)
r.json()

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

Структура запроса:

url: https://api.beorg.ru/api/document/result/s-12345?token=
methods: GET, POST

Python

import requests
import base64
r = requests.get("https://api.beorg.ru/api/document/result/s-12345?token=")
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": { ... },
      "broken": false,
      "broken_reasons": [],
      "broken_reasons_ru": []
    }
  ]
}

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

Ключ	Тип	Описание
document_id	string	номер документа в формате s-<номер документа>
documents	list	список данных по каждому документу
documents[].key	string	ключ заданный при отправке документа для отслеживания
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	метаданные с точностью обработки по каждому полю
verifications	dictionary	метаданные совершенных проверок
broken	boolean	Является ли документ бракованным
broken_reasons	list	список причин брака (англ)
broken_reasons_ru	list	список причин брака (рус)