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

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

Важно: документы для обработки должны быть закодированы в формат 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": "OTPR",
      "type": "OTPR"
    }
  ],
  "token": "<token>",
  "machine_uid": "<machine_uid>"
}

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

{
  "document_id": "s-12345"
}

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

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

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

Ключ	Описание
`key`	Свободный ключ для разделения документов при загрузке и получении результатов. Если не указан, вместо него используется ключ `type`
`type`	Тип документа (`OTPR`)
`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"
            }
        ]
    }
)
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": "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": {
        "confidences": {
          "LoanAgreementDate": 0.96,
          "DebtorLastName": 0.98,
          "DebtorFirstName": 0.97,
          "OrderNumber": 0.95,
          "OrderDate": 0.99,
          "AmountOwed": 0.94,
          "TotalAmount": 0.93
        },
        "verifications": {
          "amount_format_valid": true,
          "date_format_valid": true
        }
      },
      "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 (`{key: float}`)	Метаданные с точностью обработки по каждому полю — содержит ключи полей и значения уровня уверенности. Значения от `0.0000` до `0.9999`, где чем значение больше, тем уверенность в результате выше. Максимальная уверенность — `0.9999`
`broken`	boolean	Является ли документ бракованным
`broken_reasons`	list	Список причин брака (на английском языке)
`broken_reasons_ru`	list	Список причин брака (на русском языке)