Паспорт транспортного средства

Документ, содержащий полную информацию об автомобиле, его технических характеристиках, собственниках и истории регистрации. ПТС необходим для идентификации транспортного средства, его регистрации в ГИБДД, оформления купли‑продажи и других юридических операций.

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

Документы для обработки должны быть закодированы в формат 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": "PTS1",
      "type": "PTS",
      "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`	Тип документа (`PTS` для ПТС)
`options`	Опции обработки документа

Пример запроса (Python) для отправки ПТС

import requests
import base64

# Кодируем изображение ПТС в base64
with open("<путь до файла ПТС>", "rb") as image_file:
    b64_pts = 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_pts],  # один файл — ПТС
        "process_info": [
            {
                "key": "PTS1",
                "type": "PTS",
                "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-39182",
  "documents": [
    {
      "key": "PTS1",
      "type": "PTS",
      "data": {
        "Series": "12PT",
        "Number": "345678",
        "Vin": "",
        "Brand": "Toyota",
        "Model": "Camry",
        "VehicleType": "легковой автомобиль",
        "VehicleCategory": "B",
        "ReleaseYear": "2020",
        "VehicleChassis": "не указан",
        "VehicleBody": "",
        "Color": "серебристый",
        "EnginePower": "181 л.с.",
        "EngineCylinderVolume": "2487 см³",
        "EngineType": "бензиновый",
        "MaxMass": "2100 кг",
        "Mass": "1570 кг",
        "ExportCountry": "Япония",
        "IssuedBy": "ООО «Авто-Импорт»",
        "IssueDate": "15.03.2021",
        "HasSignature": "да",
        "Records": [
          {
            "LOAddress": "г. Москва, ул. Ленина, д. 1",
            "LOFirstName": "Иван",
            "LOGender": "M",
            "LOLastName": "Петров",
            "LOMiddleName": "Сергеевич",
            "LOOrgName": null,
            "LOOwnershipDocument": "договор купли‑продажи №123 от 20.03.2021",
            "LOSaleDate": "20.03.2021"
          }
        ]
      },
      "metadata": {
        "confidences": {
          "Series": 0.9990,
          "Number": 0.9985,
          "Vin": 0.9995,
          "Brand": 0.9992,
          "Model": 0.9991,
          "VehicleType": 0.9980,
          "ReleaseYear": 0.9993,
          "Color": 0.9975,
          "EnginePower": 0.9988,
          "IssueDate": 0.9994
        },
        "verifications": {
          "status": 0,
          "status_text": "ок",
          "bad_fields": []
        }
      },
      "broken": false,
      "broken_reasons": [],
      "broken_reasons_ru": []
    }
  ]
}

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

Ключ	Тип	Описание
`document_id`	string	Номер документа в формате `s-<номер документа>`
`documents`	list	Список данных по каждому документу
`documents[].key`	string	Ключ, заданный при отправке документа для отслеживания (`PTS1`)
`documents[].type`	string	Тип документа (`PTS`)
`documents[].data`	dictionary	Обработанные данные по каждому полю — содержит ключи полей и их определённые значения
`Series`	string	Серия ПТС
`Number`	string	Номер ПТС
`Vin`	string	Идентификационный номер (VIN-номер)
`Brand`	string	Марка автомобиля
`Model`	string	Модель автомобиля
`VehicleType`	string	Тип ТС
`VehicleCategory`	string	Категория ТС
`ReleaseYear`	string	Год изготовления ТС
`VehicleChassis`	string	Шасси (рама) №
`VehicleBody`	string	Кузов
`Color`	string	Цвет кузова
`EnginePower`	string	Мощность двигателя
`EngineCylinderVolume`	string	Рабочий объём двигателя
`EngineType`	string	Тип двигателя (бензиновый, дизельный, электрический и т. д.)
`MaxMass`	string	Разрешённая максимальная масса (в кг)
`Mass`	string	Масса без нагрузки (в кг)
`ExportCountry`	string	Страна вывоза транспортного средства
`IssuedBy`	string	Наименование организации, выдавшей паспорт ТС
`IssueDate`	string	Дата выдачи паспорта (в формате ДД.ММ.ГГГГ)
`HasSignature`	string	Наличие подписи в документе (`да`/`нет`)
`Records`	list	Список записей о собственниках ТС (история владения)
`Records[].LOOrgName`	string	Наименование организации (если собственник — юрлицо)
`Records[].LOGender`	string	Пол собственника (`M` — мужской, `F` — женский)
`Records[].LOLastName`	string	Фамилия собственника
`Records[].LOFirstName`	string	Имя собственника
`Records[].LOMiddleName`	string	Отчество собственника
`Records[].LOAddress`	string	Адрес собственника
`Records[].LOSaleDate`	string	Дата продажи/передачи ТС (в формате ДД.ММ.ГГГГ)
`Records[].LOOwnershipDocument`	string	Документ, подтверждающий право собственности (договор купли‑продажи, дарения и т. п.)
`metadata`	dictionary	Содержит ключи метаданных
`confidences`	dictionary (`{key: float}`)	Метаданные с точностью обработки по каждому полю — содержит ключи полей и значения уровня уверенности. Значения от `0.0000` до `0.9999`, где чем значение больше, тем уверенность в результате выше. Максимальная уверенность — `0.9999`
`broken`	boolean	Является ли документ бракованным
`broken_reasons`	list	Список причин брака (на английском языке)
`broken_reasons_ru`	list	Список причин брака (на русском языке)