Свидетельство о регистрации ТС

Документ подтверждает регистрацию транспортного средства в ГИБДД РФ. Для обработки необходимо предоставить изображения обеих сторон СТС в формате base64.

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

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

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

Endpoint: POST https://api.beorg.ru/api/bescan/add_document

Заголовки:

Content-Type: application/json

Тело запроса:

{
  "project_id": "U_RATE_2",
  "images": ["<строка base64 лицевой стороны>", "<строка base64 оборотной стороны>"],
  "process_info": [
    {
      "key": "STS1",
      "type": "STS",
      "options": {
        "stages": ["verification"]
      }
    }
  ],
  "token": "<token>",
  "machine_uid": "<machine_uid>"
}

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

{
  "document_id": "s-12345"
}

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

Ключ	Описание
`project_id`	Название проекта (`U_RATE_2`)
`token`	Токен доступа (получается в разделе «Начало работы»)
`machine_uid`	Идентификатор устройства (получается в разделе «Начало работы»)
`images`	Список строк в формате base64 (файлов). Для СТС — два элемента массива: первый — лицевая сторона, второй — оборотная сторона
`process_info`	Настройки обработки документа

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

Ключ	Описание
`key`	Свободный ключ для разделения документов при загрузке и получении результатов. Если не указан, вместо него используется ключ `type`
`type`	Тип документа (`STS` для свидетельства о регистрации ТС)
`options`	Опции обработки документа

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

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

import requests
import base64

# Кодируем изображения СТС в base64: сначала лицевую сторону, затем оборотную
with open("<путь до файла лицевой стороны СТС>", "rb") as front_file:
    b64_front = base64.b64encode(front_file.read()).decode()

with open("<путь до файла оборотной стороны СТС>", "rb") as back_file:
    b64_back = base64.b64encode(back_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_front, b64_back],  # сначала лицевая, потом оборотная сторона
        "process_info": [
            {
                "key": "STS1",
                "type": "STS",
                "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-7138",
  "documents": [
    {
      "key": "STS1",
      "type": "STS",
      "data": {
        "reg_number": "А123ВС777",
        "vin": "XW8ZZZ67A8G001234",
        "brand_rus": "Тойота",
        "model_rus": "Камри",
        "brand_eng": "Toyota",
        "model_eng": "Camry",
        "vehicle_type": "легковой автомобиль",
        "vehicle_category": "B",
        "release_year": "2018",
        "engine_model": "6AR-FSE",
        "engine_number": "123456789",
        "vehicle_chassis": "",
        "vehicle_body": "ZRT270-0000001",
        "color": "серебристый",
        "vehicle_type_approval": "ОТТС RU E-JP.MT02.00391",
        "engine_power": "181 л.с.",
        "engine_volume": "2494 см³",
        "ecologic_class": "5",
        "passport_series": "77ТС",
        "passport_number": "123456",
        "max_mass": "2100 кг",
        "mass": "1570 кг",
        "data_temporary_reg": "",
        "series_bottom_front": "77СТ",
        "number_bottom_front": "123456",
        "SeriesTopBack": "77СТ",
        "NumberTopBack": "123456",
        "LastnameRu": "Иванов",
        "FirstnameRu": "Пётр",
        "MiddlenameRu": "Сергеевич",
        "LastnameEng": "Ivanov",
        "FirstnameEng": "Petr",
        "FederationSubject": "г. Москва",
        "Area": "",
        "Locality": "г. Москва",
        "Street": "ул. Тверская",
        "HouseNumber": "15",
        "BuildingNumber": "3",
        "ApartmentNumber": "45",
        "SpecialMarks": "без особых отметок",
        "DepartmentCode": "7700",
        "Date": "15.03.2023",
        "SeriesBottomBack": "77СТ",
        "NumberBottomBack": "123456"
      },
      "metadata": {
        "confidences": {
          "reg_number": 0.9995,
          "vin": 0.9973,
          "brand_rus": 0.9998,
          "model_rus": 0.9997,
          "vehicle_category": 0.9999,
          "release_year": 0.9999,
          "engine_power": 0.9996,
          "ecologic_class": 0.9999,
          "passport_series": 0.9999,
          "max_mass": 0.9999,
          "mass": 0.9999,
          "LastnameRu": 0.9922,
          "FirstnameRu": 0.9980,
          "Locality": 0.9972
        },
        "verifications": {

        }
      },
      "broken": false,
      "broken_reasons": [],
      "broken_reasons_ru": []
    }
  ]
}

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

Ключ	Тип	Описание
`document_id`	string	Номер документа в формате `s-<номер документа>`
`documents`	list	Список данных по каждому документу
`documents[].key`	string	Ключ, заданный при отправке документа для отслеживания (`STS1`)
`documents[].type`	string	Тип документа (`STS`)
`documents[].data`	dictionary	Обработанные данные по каждому полю, содержит ключи полей и их определённые значения
`reg_number`	string	Регистрационный номер ТС
`vin`	string	VIN‑номер транспортного средства
`brand_rus`	string	Марка ТС на русском языке
`model_rus`	string	Модель ТС на русском языке
`brand_eng`	string	Марка ТС на английском языке
`model_eng`	string	Модель ТС на английском языке
`vehicle_type`	string	Тип транспортного средства (например, «легковой автомобиль»)
`vehicle_category`	string	Категория ТС (A, B, C, D и т. д.)
`release_year`	string	Год выпуска ТС
`engine_model`	string	Модель двигателя
`engine_number`	string	Номер двигателя
`vehicle_chassis`	string	Номер шасси (рамы), если есть
`vehicle_body`	string	Номер кузова
`color`	string	Цвет ТС
`vehicle_type_approval`	string	Одобрение типа ТС (номер ОТТС)
`engine_power`	string	Мощность двигателя (в л. с. или кВт)
`engine_volume`	string	Рабочий объём двигателя (в см³)
`ecologic_class`	string	Экологический класс (1–6)
`passport_series`	string	Серия паспорта транспортного средства
`passport_number`	string	Номер паспорта транспортного средства
`max_mass`	string	Технически допустимая максимальная масса (в кг)
`mass`	string	Масса в снаряжённом состоянии (в кг)
`data_temporary_reg`	string	Срок временной регистрации (если есть)
`series_bottom_front`	string	Серия СТС на лицевой стороне внизу
`number_bottom_front`	string	Номер СТС на лицевой стороне внизу
`SeriesTopBack`	string	Серия СТС на оборотной стороне вверху
`NumberTopBack`	string	Номер СТС на оборотной стороне вверху
`LastnameRu`	string	Фамилия владельца на русском языке
`FirstnameRu`	string	Имя владельца на русском языке
`MiddlenameRu`	string	Отчество владельца на русском языке
`LastnameEng`	string	Фамилия владельца на английском языке
`FirstnameEng`	string	Имя владельца на английском языке
`FederationSubject`	string	Республика, край, область места регистрации
`Area`	string	Район места регистрации (если есть)
`Locality`	string	Населённый пункт места регистрации
`Street`	string	Улица места регистрации
`HouseNumber`	string	Дом
`BuildingNumber`	string	Корпус (строение)
`ApartmentNumber`	string	Номер квартиры
`SpecialMarks`	string	Особые отметки (если есть)
`DepartmentCode`	string	Код подразделения ГИБДД, выдавшего документ
`Date`	string	Дата выдачи СТС (в формате ДД.ММ.ГГГГ)
`SeriesBottomBack`	string	Серия СТС на оборотной стороне внизу
`NumberBottomBack`	string	Номер СТС на оборотной стороне внизу
`metadata`	dictionary	Содержит ключи метаданных
`confidences`	dictionary (`{key: float}`)	Метаданные с точностью обработки по каждому полю — содержит ключи полей и значения уровня уверенности. Значения от `0.0000` до `0.9999`, где чем значение больше, тем уверенность в результате выше. Максимальная уверенность — `0.9999`
`broken`	boolean	Является ли документ бракованным
`broken_reasons`	list	Список причин брака (на английском языке)
`broken_reasons_ru`	list	Список причин брака (на русском языке)