API: распознавание паспортов Кыргызстана

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

Извлекает сведения из паспорта Кыргызстана.

Как вызвать

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

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

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

import requests

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

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

with open("kyrgyzstan-passport.jpg", "rb") as f:
    response = requests.post(
        url,
        files={
            "file": ("kyrgyzstan-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": "PE6955059",
    "personal_number": "10202198254217",
    "surname": "ИСАЕВА",
    "given_names": "НАЗГУЛ",
    "surname_en": "ISAeva",
    "given_names_en": "NAZGUL",
    "gender": "F",
    "birthdate": "02.02.1982",
    "birthplace": "КЫРГЫЗ РЕСПУБЛИКАСЫ KYRGYZ REPUBLIC",
    "issue_date": "07.08.2023",
    "expiry_date": "07.08.2033"
  },
  "metadata": {
    "number": {
      "confidence": 0.9939739070821696
    },
    "personal_number": {
      "confidence": 0.9966704022273325
    },
    "surname": {
      "confidence": 0.8801585421029675
    },
    "given_names": {
      "confidence": 0.9507113232293952
    },
    "surname_en": {
      "confidence": 0.5454050423101062
    },
    "given_names_en": {
      "confidence": 0.9884084863775252
    },
    "gender": {
      "confidence": 0.9999963045256735
    },
    "birthdate": {
      "confidence": 0.9984209477417432
    },
    "birthplace": {
      "confidence": 0.38867338811321117
    },
    "issue_date": {
      "confidence": 0.9996464311022545
    },
    "expiry_date": {
      "confidence": 0.9999077405224903
    }
  }
}

Поле	Описание
number	Номер документа
personal_number	Персональный идентификационный номер
surname	Фамилия
given_names	Имя
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 ₽ за страницу. Не входит в годовую подписку.