API: распознавание паспортов Беларуси

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

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

Как вызвать

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

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

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

import requests

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

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

with open("belarus-passport.jpg", "rb") as f:
    response = requests.post(
        url,
        files={
            "file": ("belarus-passport.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": "0000000",
    "personal_number": "00000000000000",
    "surname_en": "IVANOV",
    "given_names_en": "ALEXEI",
    "gender": "M",
    "birthdate": "01.01.1990",
    "birthplace": "MINSK, BELARUS",
    "issue_date": "01.01.2024",
    "expiry_date": "01.01.2034"
  },
  "metadata": {
    "number": {
      "confidence": 0.999712549842758
    },
    "personal_number": {
      "confidence": 0.9578290062975151
    },
    "surname_en": {
      "confidence": 0.9938942964042619
    },
    "given_names_en": {
      "confidence": 0.9427019681245136
    },
    "gender": {
      "confidence": 0.9999724634116024
    },
    "birthdate": {
      "confidence": 0.9997174346340454
    },
    "birthplace": {
      "confidence": 0.9948806732450168
    },
    "issue_date": {
      "confidence": 0.9999567288990747
    },
    "expiry_date": {
      "confidence": 0.9999183483027276
    }
  }
}

Поле	Описание
number	Номер документа
personal_number	Персональный идентификационный номер
surname_en	Фамилия — международная запись
given_names_en	Все личные имена — международная запись
gender	Пол
birthdate	Дата рождения
birthplace	Место рождения — международная запись
issue_date	Дата выдачи
expiry_date	Дата окончания действия

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 ₽ за страницу. Не входит в годовую подписку.