Паспорт иностранного гражданина

Поддерживаемые страны: РФ, Азербайджан, Армения, Белоруссия, Казахстан, Киргизстан, Молдова, Таджикистан, Туркменистан, Узбекистан и другие страны с латиницей.

Пример изображения документа:

Важные ограничения: * обрабатываются только поля, напечатанные латиницей; * кириллица и национальные алфавиты не поддерживаются; * для обработки кириллицы или других алфавитов необходимо отправить запрос на kyc@beorg.ru.

Отправка документа

Endpoint: POST https://api.beorg.ru/api/bescan/add_document

Заголовки:

Content-Type: application/json

Тело запроса:

{
  "project_id": "U_RATE_3",
  "images": ["<строка base64>"],
  "process_info": [
    {
      "key": "PASSPORT_FRGN1",
      "type": "PASSPORT_FRGN"
    }
  ],
  "token": "<token>",
  "machine_uid": "<machine_uid>"
}

Пример ответа об успешной загрузке:

{
  "document_id": "s-12345"
}

Структура передаваемых данных

Ключ	Описание
`project_id`	Название проекта
`token`	Токен доступа
`machine_uid`	Идентификатор устройства
`images`	Список строк в формате base64 (файлов)
`process_info`	Настройки обработки

Структура `process_info`

Ключ	Описание
`key`	Свободный ключ для разделения документов при загрузке и получении результатов. Если не указан, вместо него используется ключ `type`
`type`	Тип документа (`PASSPORT_FRGN`)
`options`	Опции обработки документа

Для получения token, machine_uid и project_id обратитесь в подраздел «Начало работы».

Пример запроса (Python)

import requests
import base64

with open("<путь до файла Паспорта иностранного гражданина>", "rb") as image_file:
    b64 = base64.b64encode(image_file.read()).decode()

r = requests.post(
    "https://api.beorg.ru/api/bescan/add_document",
    headers={"Content-Type": "application/json"},
    json={
        "project_id": project_id,
        "token": token,
        "machine_uid": machine_uid,
        "images": [b64],
        "process_info": [
            {
                "key": "PASSPORT_FRGN1",
                "type": "PASSPORT_FRGN"
            }
        ]
    }
)
print(r.json())

Получение результатов

Endpoint: GET/POST https://api.beorg.ru/api/document/result/s-12345?token=<token>

Пример запроса для получения результатов (Python):

import requests

r = requests.get("https://api.beorg.ru/api/document/result/s-12345?token=<token>")
print(r.json())

Пример ответа по обработанному документу

{
  "document_id": "s-7141",
  "documents": [
    {
      "key": "PASSPORT_FRGN1",
      "type": "PASSPORT_FRGN",
      "data": {
        "Code": "RUS",
        "Number": "78 1234567",
        "IDNumber": "123456789012",
        "IssuedBy": "FMS 77001",
        "Gender": "M",
        "LastName": "IVANOV",
        "FirstName": "IVAN",
        "MiddleName": "IVANOVICH",
        "BirthDate": "15.03.1985",
        "BirthPlace": "MOSCOW, RUS",
        "IssueDate": "20.05.2020",
        "FutureDate": "20.05.2030",
        "Nationality": "RUSSIAN FEDERATION",
        "MRZ1": "P<RUSIVANOV<<IVAN<IVANOVICH<<<<<<<<<<<",
        "MRZ2": "7812345679RUS8503151M2005206F<<<<<<8",
        "HasPhoto": "true",
        "HasOwnerSignature": "true"
      },
      "metadata": {
        "confidences": {
          "LastName": 0.98,
          "FirstName": 0.97,
          "BirthDate": 0.99,
          "Number": 0.96,
          "IssueDate": 0.95,
          "Nationality": 0.94,
          "MRZ1": 0.99,
          "MRZ2": 0.99
        },
        "verifications": {
          "mrz_valid": true,
          "dates_consistent": true,
          "document_valid": true
        }
      },
      "broken": false,
      "broken_reasons": [],
      "broken_reasons_ru": []
    }
  ]
}

Описание ключей в ответе

Ключ	Тип	Описание
`document_id`	string	Номер документа в формате `s-<номер документа>`
`documents`	list	Список данных по каждому документу
`documents[].key`	string	Ключ, заданный при отправке документа для отслеживания
`documents[].type`	string	Тип документа (`PASSPORT_FRGN`)
`documents[].data`	dictionary	Обработанные данные по каждому полю — содержит ключи полей и их определённые значения
`Code`	string	Код государства (например, `RUS`, `KAZ`)
`Number`	string	Номер иностранного паспорта
`IDNumber`	string	Идентификационный номер (ID‑карта)
`IssuedBy`	string	Кем выдан документ
`Gender`	string	Пол (`M` — мужской, `F` — женский)
`LastName`	string	Фамилия (латиницей)
`FirstName`	string	Имя (латиницей)
`MiddleName`	string	Отчество (латиницей, если присутствует)
`BirthDate`	string	Дата рождения (в формате ДД.ММ.ГГГГ)
`BirthPlace`	string	Место рождения (латиницей)
`IssueDate`	string	Дата выдачи документа (в формате ДД.ММ.ГГГГ)
`FutureDate`	string	Дата, до которой документ действителен (в формате ДД.ММ.ГГГГ)
`Nationality`	string	Гражданство (латиницей)
`MRZ1`	string	Первая строка машиносчитываемой зоны (MRZ)
`MRZ2`	string	Вторая строка машиносчитываемой зоны (MRZ)
`HasPhoto`	string (`true`/`false`)	Наличие фото в документе
`HasOwnerSignature`	string (`true`/`false`)	Наличие подписи владельца
`metadata`	dictionary	Содержит ключи метаданных
`confidences`	dictionary (`{key: float}`)	Метаданные с точностью обработки по каждому полю — содержит ключи полей и значения уровня уверенности. Значения от `0.0000` до `0.9999`, где чем значение больше, тем уверенность в результате выше. Максимальная уверенность — `0.9999`
`broken`	boolean	Является ли документ бракованным
`broken_reasons`	list	Список причин брака (на английском языке)
`broken_reasons_ru`	list	Список причин брака (на русском языке)