API: распознавание свидетельств о рождении РФ

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

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

Как вызвать

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

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

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

import requests

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

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

with open("birth-certificate.jpg", "rb") as f:
    response = requests.post(
        url,
        files={
            "file": ("birth-certificate.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": {
    "series": null,
    "number": null,
    "surname": "Турсунов",
    "name": "Назар",
    "patronymic": "Дмитриевич",
    "birthdate": "12.01.2011",
    "birthplace": "г. Новосибирск, Новосибирская область, Россия",
    "issue_date": "26.04.2011",
    "father_surname": "Турсунов",
    "father_name": "Дмитрий",
    "father_patronymic": "Александрович",
    "mother_surname": "Турсунова",
    "mother_name": "Евгения",
    "mother_patronymic": "Сергеевна"
  },
  "metadata": {
    "series": {
      "confidence": 0.9794808497929005
    },
    "number": {
      "confidence": 0.9838278304530137
    },
    "surname": {
      "confidence": 0.985988297255095
    },
    "name": {
      "confidence": 0.9903322104717258
    },
    "patronymic": {
      "confidence": 0.9649438336742476
    },
    "birthdate": {
      "confidence": 0.9997055205778066
    },
    "birthplace": {
      "confidence": 0.9927100035540705
    },
    "issue_date": {
      "confidence": 0.9996340422476869
    },
    "father_surname": {
      "confidence": 0.9990569909303069
    },
    "father_name": {
      "confidence": 0.9999123888519666
    },
    "father_patronymic": {
      "confidence": 0.9988621322090365
    },
    "mother_surname": {
      "confidence": 0.7485113008349145
    },
    "mother_name": {
      "confidence": 0.9959872504480374
    },
    "mother_patronymic": {
      "confidence": 0.995320741862879
    }
  }
}

Поле	Описание
series	Серия документа
number	Номер документа
surname	Фамилия родившегося
name	Имя родившегося
patronymic	Отчество родившегося
birthdate	Дата рождения
birthplace	Место рождения
issue_date	Дата выдачи
father_surname	Фамилия отца
father_name	Имя отца
father_patronymic	Отчество отца
mother_surname	Фамилия матери
mother_name	Имя матери
mother_patronymic	Отчество матери

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