API: распознавание паспортов РФ

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

Извлекает сведения из паспорта гражданина РФ.

Как вызвать

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

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

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

import requests

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

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

with open("passport.jpg", "rb") as f:
    response = requests.post(
        url,
        files={
            "file": ("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": {
    "surname": "КУЗНЕЦОВ",
    "name": "ДМИТРИЙ",
    "patronymic": "СЕРГЕЕВИЧ",
    "gender": "М",
    "birthdate": "15.08.1990",
    "birthplace": "ГОР. МОСКВА",
    "series": "45 15",
    "number": "940229",
    "issue_authority": "ОТДЕЛОМ УФМС РОССИИ ПО Г. МОСКВЕ ПО РАЙОНУ ЗАМОСКВОРЕЧЬЕ",
    "issue_date": "23.04.2015",
    "issue_authority_code": "770-053",
    "registration_address": null,
    "registration_authority_code": null,
    "registration_date": null
  },
  "metadata": {
    "surname": {
      "confidence": 0.9986037465211766
    },
    "name": {
      "confidence": 0.9977276816984461
    },
    "patronymic": {
      "confidence": 0.993664838707191
    },
    "gender": {
      "confidence": 0.9999339624169533
    },
    "birthdate": {
      "confidence": 0.9999823573372132
    },
    "birthplace": {
      "confidence": 0.972707264437231
    },
    "series": {
      "confidence": 0.9990878088848497
    },
    "number": {
      "confidence": 0.9995528076156194
    },
    "issue_authority": {
      "confidence": 0.7057029788252084
    },
    "issue_date": {
      "confidence": 0.9999700793634253
    },
    "issue_authority_code": {
      "confidence": 0.9999926090786457
    },
    "registration_address": {
      "confidence": 0.5606562114580618
    },
    "registration_authority_code": {
      "confidence": 0.9999521993597025
    },
    "registration_date": {
      "confidence": 0.9999997615814777
    }
  }
}

Поле	Описание
surname	Фамилия владельца паспорта
name	Имя владельца паспорта
patronymic	Отчество владельца паспорта
gender	Пол
birthdate	Дата рождения
birthplace	Место рождения
series	Серия паспорта
number	Номер паспорта
issue_authority	Орган, выдавший паспорт
issue_date	Дата выдачи паспорта
issue_authority_code	Код подразделения, выдавшего паспорт
registration_address	Адрес регистрации по месту жительства
registration_authority_code	Код подразделения, оформившего регистрацию
registration_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 ₽ за страницу. Не входит в годовую подписку.