Отмена судебного приказа

Изображение документа "Определение об отмене судебного приказа"

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

Документы для обработки должны быть закодированы в формат 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": "OTPR",
                "type": "OTPR",
            }
        ],
    },
)
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": "OTPR",
      "type": "OTPR",
      "data": {
        "LoanAgreementDate": "01.01.2023",
        "Gender": "M",
        "DebtorLastName": "Иванов",
        "DebtorFirstName": "Иван",
        "DebtorMiddleName": "Иванович",
        "LoanAgreementNumber": "001/1234567",
        "OrderNumber": "1-2345/678",
        "OrderDate": "02.03.2025",
        "AmountOwed": "1234,55",
        "Duties": "200,00",
        "TotalAmount": "1434,55"
      },
      "metadata": { ... },
      "broken": null,
      "broken_reasons": [],
      "broken_reasons_ru": []
    },
    "broken": false,
    "broken_reasons": [],
    "broken_reasons_ru": []
  ]
}

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

Ключ	Тип	Описание
document_id	string	номер документа в формате s-<номер документа>
documents	list	список данных по каждому документу
documents[].key	string	ключ заданный при отправке документа для отслеживания
documents[].type	string	тип документа (OTPR)
documents[].data	dictionary	обработанные данные по каждому полю
LoanAgreementDate	string	Дата определения об отмене приказа
Gender	string	Пол должника (M/F)
DebtorLastName	string	Фамилия должника
DebtorFirstName	string	Имя должника
DebtorMiddleName	string	Отчество должника
LoanAgreementNumber	string	Номер договора займа (из отменяемого приказа)
OrderNumber	string	Номер дела (из отменяемого приказа)
OrderDate	string	Дата отмененного судебного приказа
AmountOwed	string	Сумма задолженности (из отменяемого приказа)
Duties	string	Сумма госпошлины (из отменяемого приказа)
TotalAmount	string	Общая сумма к взысканию (из отменяемого приказа)
metadata	dictionary	содержит ключи метаданных
confidences	dictionary	метаданные с точностью обработки по каждому полю
verifications	dictionary	метаданные совершенных проверок
broken	boolean	Является ли документ бракованным
broken_reasons	list	список причин брака (англ)
broken_reasons_ru	list	список причин брака (рус)