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

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

Документы для обработки должны быть закодированы в формат 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": "STS1",
                "type": "STS",
            }
        ],
    },
)
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-7138",
  "documents": [
    {
      "key": "STS1",
      "type": "STS",
      "data": {
        "reg_number": "reg_number",
        "vin": "vin",
        "brand_rus": "brand_rus",
        "model_rus": "model_rus",
        "brand_eng": "brand_eng",
        "model_eng": "model_eng",
        "vehicle_type": "vehicle_type",
        "vehicle_category": "vehicle_category",
        "release_year": "release_year",
        "engine_model": "engine_model",
        "engine_number": "engine_number",
        "vehicle_chassis": "vehicle_chassis",
        "vehicle_body": "vehicle_body",
        "color": "color",
        "vehicle_type_approval": "vehicle_type_approval",
        "engine_power": "engine_power",
        "engine_volume": "engine_volume",
        "ecologic_class": "ecologic_class",
        "passport_series": "passport_series",
        "passport_number": "passport_number",
        "max_mass": "max_mass",
        "mass": "mass",
        "data_temporary_reg": "data_temporary_reg",
        "series_bottom_front": "series_bottom_front",
        "number_bottom_front": "number_bottom_front",
        "SeriesTopBack": "SeriesTopBack",
        "NumberTopBack": "NumberTopBack",
        "LastnameRu": "LastnameRu",
        "FirstnameRu": "FirstnameRu",
        "MiddlenameRu": "MiddlenameRu",
        "LastnameEng": "LastnameEng",
        "FirstnameEng": "FirstnameEng",
        "FederationSubject": "FederationSubject",
        "Area": "Area",
        "Locality": "Locality",
        "Street": "Street",
        "HouseNumber": "HouseNumber",
        "BuildingNumber": "BuildingNumber",
        "ApartmentNumber": "ApartmentNumber",
        "SpecialMarks": "SpecialMarks",
        "DepartmentCode": "DepartmentCode",
        "Date": "Date",
        "SeriesBottomBack": "SeriesBottomBack",
        "NumberBottomBack": "NumberBottomBack"
      },
      "metadata": {
        "confidences": {
          "reg_number": 1,
          "vin": 0.997328579425812,
          "brand_rus": 1,
          "model_rus": 1,
          "brand_eng": 1,
          "model_eng": 1,
          "vehicle_category": 1,
          "release_year": 1,
          "vehicle_chassis": 1,
          "vehicle_body": 1,
          "color": 1,
          "engine_power": 0.999571621417999,
          "ecologic_class": 1,
          "passport_series": 0.999932527542114,
          "passport_number": 0.999932527542114,
          "max_mass": 0.999957740306854,
          "mass": 0.999994158744812,
          "series_bottom_front": 0.997173547744751,
          "number_bottom_front": 0.997173547744751,
          "SeriesTopBack": 0.997505486011505,
          "NumberTopBack": 0.997505486011505,
          "LastnameRu": 0.992222011089325,
          "FirstnameRu": 0.998002409934998,
          "MiddlenameRu": 0.998872518539429,
          "LastnameEng": 0.961436331272125,
          "FirstnameEng": 0.999751210212708,
          "FederationSubject": 1,
          "Locality": 0.997237503528595,
          "Street": 0.996907293796539,
          "HouseNumber": 0.999993324279785,
          "SpecialMarks": 0.930226266384125,
          "DepartmentCode": 0.999892055988312,
          "Date": 0.961017608642578,
          "SeriesBottomBack": 0.997839689254761,
          "NumberBottomBack": 0.997839689254761
        },
        "verifications": {

        }
      }
    }
  ]
}

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

Ключ	Тип	Описание
document_id	string	номер документа в формате s-<номер документа>
documents	list	список данных по каждому документу
documents[].key	string	ключ заданный при отправке документа для отслеживания
documents[].type	string	тип документа
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	категория ТС
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	экологический класс
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.
verifications	dictionary {key: boolean, key: integer}	метаданные совершенных проверок - содержит ключи и их значения проверок, см. Правила проверок