API: распознавание водительских удостоверений

Это документация для разработчиков. Демоформа и сценарии использования сервиса — на странице «Распознавание документов»

Извлекает сведения из водительского удостоверения.

Как вызвать

Чтобы вызвать метод, и подтвердите почту.

Пример запроса:

curl -sS \
  -X POST "https://docs.dadata.ru/api/v1/extract/driver_license" \
  -H "Authorization: Token ${API_KEY}" \
  -H "X-Secret: ${SECRET_KEY}" \
  -F "file=@driver_license.jpg;type=image/jpeg"

import requests

url = "https://docs.dadata.ru/api/v1/extract/driver_license"

headers = {
    "Authorization": "Token ${API_KEY}",
    "X-Secret": "${SECRET_KEY}",
}

with open("driver_license.jpg", "rb") as f:
    response = requests.post(
        url,
        files={
            "file": ("driver_license.jpg", f, "image/jpeg"),
        },
        headers=headers,
        timeout=600,
    )

response.raise_for_status()
data = response.json()

print("result:", data["data"])
print("metadata:", data["metadata"])

Укажите при вызове:

${API_KEY} — API-ключ.
${SECRET_KEY} — секретный ключ.

Тело запроса передавайте в кодировке UTF-8.

Запрос отправляйте в формате multipart/form-data.

Параметры запроса

Название	Тип	Обяз.?	По умолч.	Описание
file	file	✓		Документ для обработки

Что в ответе

Пример ответа

{
  "data": {
    "number": "00 00 000000",
    "surname": "ИВАНОВ",
    "name": "ИЛЬЯ",
    "patronymic": "СЕРГЕЕВИЧ",
    "birthdate": "01.01.1990",
    "birthplace": "Г. МОСКВА",
    "issue_date": "01.01.2024",
    "expiry_date": "01.01.2034",
    "issue_authority": "ГИБДД 7700",
    "residence_address": "Г. МОСКВА",
    "categories": {
      "B": {
        "valid_from": "01.01.2024",
        "valid_to": "01.01.2034"
      },
      "B1": {
        "valid_from": "01.01.2024",
        "valid_to": "01.01.2034"
      },
      "M": {
        "valid_from": "01.01.2024",
        "valid_to": "01.01.2034"
      }
    },
    "special_marks": "00 00 000000"
  },
  "metadata": {
    "number": {
      "confidence": 0.9923020543631105
    },
    "surname": {
      "confidence": 0.999020226029575
    },
    "name": {
      "confidence": 0.9974270671927271
    },
    "patronymic": {
      "confidence": 0.9998075140497616
    },
    "birthdate": {
      "confidence": 0.9998741308286652
    },
    "birthplace": {
      "confidence": 0.9961341444290932
    },
    "issue_date": {
      "confidence": 0.9999768739326302
    },
    "expiry_date": {
      "confidence": 0.9998359949138526
    },
    "issue_authority": {
      "confidence": 0.986705495147859
    },
    "residence_address": {
      "confidence": 0.9997257746335437
    },
    "categories": {
      "B": {
        "confidence": 0.9997801072260226,
        "valid_from": {
          "confidence": 0.9999806884689187
        },
        "valid_to": {
          "confidence": 0.9999468354816792
        }
      },
      "B1": {
        "confidence": 0.9999798540367254,
        "valid_from": {
          "confidence": 0.9999985694905718
        },
        "valid_to": {
          "confidence": 0.9999767547297425
        }
      },
      "M": {
        "confidence": 0.9999741322534375,
        "valid_from": {
          "confidence": 0.9999976158197796
        },
        "valid_to": {
          "confidence": 0.9999908209686689
        }
      }
    },
    "special_marks": {
      "confidence": 0.9451618293547244
    }
  }
}

Поле	Описание
number	Серия и номер водительского удостоверения
surname	Фамилия владельца
name	Имя владельца
patronymic	Отчество владельца
birthdate	Дата рождения
birthplace	Место рождения
issue_date	Дата выдачи удостоверения
expiry_date	Дата окончания срока действия удостоверения
issue_authority	Орган, выдавший удостоверение
residence_address	Место проживания
categories	Открытые категории транспортных средств
categories. `code` .valid_from	Дата начала действия категории
categories. `code` .valid_to	Дата окончания действия категории
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 ₽ за страницу. Не входит в годовую подписку.