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

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

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

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

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

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

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

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

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

{
    "document_id": "s-12345"
}

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

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

Структура prosess_info:

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

Структура process_info.options:

Ключ	Описание
stages	этапы обработки документа (Доступны: verification, biometry_match, biometry_liveness)
relation	связь с иным документом в одном запросе (Доступны: biometry_match)

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

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={
        "project_id": project_id,
        "token": token,
        "machine_uid": machine_uid,
        "images": [b64],
        "process_info": [
            {
                "key": "PTS1",
                "type": "PTS",
            }
        ],
    },
)
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-39182",
  "documents": [
    {
      "key": "PTS1",
      "type": "PTS",
      "data": {
        "Series": "",
        "Number": "",
        "Vin": "",
        "Brand": "",
        "Model": "",
        "VehicleType": "",
        "VehicleCategory": "",
        "ReleaseYear": "",
        "VehicleChassis": "",
        "VehicleBody": "",
        "Color": "",
        "EnginePower": "",
        "EngineCylinderVolume": "",
        "EngineType": "",
        "MaxMass": "",
        "Mass": "",
        "ExportCountry": "",
        "IssuedBy": "",
        "IssueDate": "",
        "HasSignature": "",
        "Records": [
          {
            "LOAddress": "",
            "LOFirstName": "",
            "LOGender": "",
            "LOLastName": "",
            "LOMiddleName": "",
            "LOOrgName": "",
            "LOOwnershipDocument": "",
            "LOSaleDate": ""
          }
        ]
      },
      "metadata": {
        "confidences": null,
        "verifications": {},
      },
    }
  ]
}

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

Ключ	Тип	Описание
document_id	string	номер документа в формате s-<номер документа>
documents	list	список данных по каждому документу
documents[].key	string	ключ заданный при отправке документа для отслеживания
documents[].type	string	тип документа
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	Дата выдачи паспорта
Records[].LOOrgName	string	Наименование организации (Последний собственник)
Records[].LOGender	string	Пол
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.