↑ Все API
API: распознавание СТС
Это документация для разработчиков. Демоформа и сценарии использования сервиса — на странице «Распознавание документов»
Извлекает сведения из свидетельства о регистрации транспортного средства.
Как вызвать
Чтобы вызвать метод, и подтвердите почту.
Пример запроса:
curl -sS \
-X POST "https://docs.dadata.ru/api/v1/extract/vehicle_registration" \
-H "Authorization: Token ${API_KEY}" \
-H "X-Secret: ${SECRET_KEY}" \
-F "file=@vehicle_registration.jpg;type=image/jpeg"Укажите при вызове:
${API_KEY}— API-ключ.${SECRET_KEY}— секретный ключ.
Тело запроса передавайте в кодировке UTF-8.
Запрос отправляйте в формате multipart/form-data.
Параметры запроса
| Название | Тип | Обяз.? | По умолч. | Описание |
|---|---|---|---|---|
| file | file | ✓ | Документ для обработки |
Что в ответе
Пример ответа
{
"data": {
"number": "78 21 549858",
"registration_number": "М372ОЕ178",
"vin": "XTN31100011023624",
"model": "ГАЗ 3110",
"model_en": "GAZ 3110",
"vehicle_type": "СЕДАН",
"vehicle_category": "В",
"production_year": 2001,
"engine_model": null,
"engine_number": null,
"chassis_number": null,
"body_number": "31100010430019",
"color": "СНЕЖНО-БЕЛЫЙ",
"vehicle_type_approval_number": null,
"engine_power": "96.06/131",
"engine_displacement": null,
"engine_type": null,
"environmental_class": null,
"vehicle_passport_number": "52КА 902367",
"permitted_max_mass": 1790,
"curb_mass": 1400,
"surname": null,
"surname_en": null,
"name": null,
"name_en": null,
"patronymic": null,
"legal_name": null,
"legal_name_en": null,
"region": null,
"area": null,
"city": null,
"street": null,
"house": null,
"block": null,
"flat": null,
"special_marks": null,
"issue_authority": null,
"issue_date": null
},
"metadata": {
"number": {
"confidence": 0.9901835161846675
},
"registration_number": {
"confidence": 0.9438748012846161
},
"vin": {
"confidence": 0.5301210024475428
},
"model": {
"confidence": 0.9930839579851942
},
"model_en": {
"confidence": 0.9984671759375664
},
"vehicle_type": {
"confidence": 0.9026509621619226
},
"vehicle_category": {
"confidence": 0.6220367578090021
},
"production_year": {
"confidence": 0.9990706743709257
},
"engine_model": {
"confidence": 0.9905108898750022
},
"engine_number": {
"confidence": 0.993828827386908
},
"chassis_number": {
"confidence": 0.8094137583701273
},
"body_number": {
"confidence": 0.9996606071757228
},
"color": {
"confidence": 0.9832982696752929
},
"vehicle_type_approval_number": {
"confidence": 0.9524973551857243
},
"engine_power": {
"confidence": 0.9041505031869269
},
"engine_displacement": {
"confidence": 0.9996198669291387
},
"engine_type": {
"confidence": 0.9995632887422857
},
"environmental_class": {
"confidence": 0.651164010835427
},
"vehicle_passport_number": {
"confidence": 0.5378811444427434
},
"permitted_max_mass": {
"confidence": 0.9998352798920728
},
"curb_mass": {
"confidence": 0.9999939203633587
},
"surname": {
"confidence": 0.9998613788093218
},
"surname_en": {
"confidence": 0.999995112442896
},
"name": {
"confidence": 0.9999949932351057
},
"name_en": {
"confidence": 0.9999977350285644
},
"patronymic": {
"confidence": 0.9999982118638471
},
"legal_name": {
"confidence": 0.9999202553446581
},
"legal_name_en": {
"confidence": 0.9999918938339075
},
"region": {
"confidence": 0.9989449200797729
},
"area": {
"confidence": 0.9999955892755635
},
"city": {
"confidence": 0.9999779467683537
},
"street": {
"confidence": 0.999998927117538
},
"house": {
"confidence": 0.9999986886995842
},
"block": {
"confidence": 0.9999986886995842
},
"flat": {
"confidence": 0.9999991655356624
},
"special_marks": {
"confidence": 0.8505245556558543
},
"issue_authority": {
"confidence": 0.9815759566777652
},
"issue_date": {
"confidence": 0.999644644207703
}
}
}
| Поле | Описание |
|---|---|
| number | Серия и номер СТС |
| registration_number | Государственный регистрационный номер транспортного средства |
| vin | Идентификационный номер транспортного средства (VIN) |
| model | Марка и модель транспортного средства |
| model_en | Марка и модель латиницей |
| vehicle_type | Тип транспортного средства |
| vehicle_category | Категория транспортного средства |
| production_year | Год выпуска |
| color | Цвет |
| vehicle_type_approval_number | Номер одобрения типа транспортного средства (ОТТС) |
| vehicle_passport_number | Серия и номер паспорта транспортного средства (ПТС) |
| permitted_max_mass | Разрешённая максимальная масса |
| curb_mass | Масса без нагрузки |
| engine_model | Модель двигателя |
| engine_number | Номер двигателя |
| chassis_number | Номер шасси или рамы |
| body_number | Номер кузова |
| engine_power | Мощность двигателя |
| engine_displacement | Рабочий объём двигателя |
| engine_type | Тип двигателя |
| environmental_class | Экологический класс |
| surname | Фамилия собственника — физического лица |
| surname_en | Фамилия собственника латиницей |
| name | Имя собственника |
| name_en | Имя собственника латиницей |
| patronymic | Отчество собственника |
| legal_name | Наименование собственника — юридического лица |
| legal_name_en | Наименование юридического лица латиницей |
| region | Регион |
| area | Район |
| city | Город или другой населённый пункт |
| street | Улица |
| house | Дом |
| block | Корпус или строение |
| flat | Квартира или помещение |
| issue_authority | Орган, выдавший СТС |
| issue_date | Дата выдачи СТС |
| special_marks | Особые отметки |
API возвращает объект с результатами извлечения. Он состоит из двух объектов:
- объект
dataсодержит найденные значения. - объект
metadataсодержит метаданные извлечения для каждого поля. Полеconfidenceпредставляет оценку уверенности распознавания в диапазоне от 0 до 1.
Коды ответа на запрос
| HTTP‑код ответа | Описание |
|---|---|
| 200 | Данные успешно извлечены. |
| 400 | Некорректный запрос: не передан файл, не передана схема, схема невалидна или MIME type не поддерживается. |
| 401 | Не переданы ключи авторизации |
| 403 | Переданы несуществующие ключи или недостаточно лимитов/баланса для использования. |
| 413 | Файл слишком большой. |
| 502 | Ошибка обработки на стороне сервиса. |
Ограничения
Максимальная частота запросов — 10 в минуту с одного IP-адреса. Напишите на info@dadata.ru, если этого мало.
Файл в запросе — PDF, JPG, PNG до 20 МБ.
Стоимость
3 ₽ за страницу. Не входит в годовую подписку.