Уведомление о прибытии иностранного гражданина

Уведомление о прибытии иностранного гражданина или лица без гражданства в место пребывания.

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

Документы для обработки должны быть закодированы в формат base64.

---

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

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

Заголовки:

Content-Type: application/json

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

{
  "project_id": "U_RATE_2",
  "images": ["<строка base64>"],
  "process_info": [
    {
      "key": "PRIB1",
      "type": "PRIB"
    }
  ],
  "token": "<token>",
  "machine_uid": "<machine_uid>"
}

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

{
  "document_id": "s-12345"
}

---

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

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

Структура process_info

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

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

---

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

import requests
import base64

# Кодируем изображение документа в base64
with open("<путь до файла уведомления>", "rb") as image_file:
    b64 = base64.b64encode(image_file.read()).decode()

# Отправляем запрос на API
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": "PRIB1",
                "type": "PRIB"
            }
        ]
    }
)
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-12345",
  "documents": [
    {
      "key": "PRIB",
      "type": "PRIB",
      "data": {
        "DetachablePartNotifierGender": "M",
        "DetachablePartNotifierLastName": "Иванов",
        "DetachablePartNotifierFirstName": "Иван",
        "DetachablePartNotifierMiddleName": "",
        "DetachablePartNotifierCitizenship": "СЕРБИЯ",
        "DetachablePartNotifierBirthDate": "21.10.1989",
        "DetachablePartNotifierBirthPlace": "",
        "DetachablePartNotifierIdentityDocument": "ИНОСТРАННЫЙ ПАСПОРТ",
        "DetachablePartNotifierDocSeries": "",
        "DetachablePartNotifierDocNumber": "12345",
        "DetachablePartNotifierDocIssueDate": "28.09.2020",
        "DetachablePartActualArrivalNotificationAddress": "Г МОСКВА, ПР-КТ ЛЕНИНГРАДСКИЙ, ДОМ 1, КВ. 666",
        "DetachablePartStatedEndStayDate": "07.05.2050",
        "DetachablePartHostGender": "F",
        "DetachablePartHostLastName": "ПЕТРОВА",
        "DetachablePartHostFirstName": "НАТАЛЬЯ",
        "DetachablePartHostMiddleName": "НИКОЛАЕВНА",
        "DetachablePartHostOrgName": "ООО \"РОМАШКА\"",
        "DetachablePartHostINN": "7709787777",
        "DetachablePartRegStartDate": "24.06.2024"
      },
      "metadata": {
        "confidences": null,
        "verifications": {},
        "metadata_check": {
          "status": 0,
          "checks": {
            "source_check": 1,
            "suspicious_app_detection": 0,
            "suspicious_value": "",
            "create_date": 0,
            "make": "",
            "model": "",
            "not_standart_sizes": 1,
            "incorrect_dpi": 0,
            "color_profile": 0
          }
        },
        "external_integrations": {
          "terrorist_extremist": {
            "value": null
          },
          "inn": {
            "status": null,
            "value": null
          }
        },
        "fullness": {
          "value": 0.85,
          "comment": ""
        },
        "check_result": {
          "status": "Attention",
          "details": {
            "logic": {
              "status": "Not executed"
            },
            "metadata": {
              "status": "Attention"
            },
            "fraud": {
              "status": "Not executed"
            },
            "external_integrations": {
              "status": "Not executed"
            }
          }
        }
      },
      "reasons_metadata": true,
      "broken": false,
      "broken_reasons": [],
      "broken_reasons_ru": []
    }
  ]
}

---

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

Ключ	Тип	Описание
document_id	string	Номер документа в формате s-<номер документа>
documents	list	Список данных по каждому документу
documents[].key	string	Ключ, заданный при отправке документа для отслеживания
documents[].type	string	Тип документа
documents[].data	dictionary	Обработанные данные по каждому полю, содержит ключи полей и их определённые значения
DetachablePartNotifierGender	string	Пол уведомителя
DetachablePartNotifierLastName	string	Фамилия уведомителя
DetachablePartNotifierFirstName	string	Имя уведомителя
DetachablePartNotifierMiddleName	string	Отчество уведомителя
DetachablePartNotifierCitizenship	string	Гражданство (подданство) уведомителя
DetachablePartNotifierBirthDate	string	Дата рождения уведомителя
DetachablePartNotifierBirthPlace	string	Место рождения уведомителя
DetachablePartNotifierIdentityDocument	string	Вид ДУЛ уведомителя
DetachablePartNotifierDocSeries	string	Серия ДУЛ уведомителя
DetachablePartNotifierDocNumber	string	Номер ДУЛ уведомителя
DetachablePartNotifierDocIssueDate	string	Дата выдачи ДУЛ уведомителя
DetachablePartActualArrivalNotificationAddress	string	Адрес фактического места пребывания уведомления о прибытии
DetachablePartStatedEndStayDate	string	Заявленный срок пребывания до
DetachablePartHostGender	string	Пол принимающей стороны
DetachablePartHostLastName	string	Фамилия принимающей стороны
DetachablePartHostFirstName	string	Имя принимающей стороны
DetachablePartHostMiddleName	string	Отчество принимающей стороны
DetachablePartHostOrgName	string	Наименование организации принимающей стороны
DetachablePartHostINN	string	Номер ИНН организации принимающей стороны
DetachablePartRegStartDate	string	Дата постановки на учет
metadata	dictionary	Содержит ключи метаданных
confidences	dictionary ({key: float})	Метаданные с точностью обработки по каждому полю — содержит ключи полей и значения уровня уверенности. Значения от 0.0000 до 0.9999, где чем значение больше, тем уверенность в результате выше. Максимальная уверенность — 0.9999
broken	boolean	Является ли документ бракованным
broken_reasons	list	Список причин брака (на английском языке)
broken_reasons_ru	list	Список причин брака (на русском языке)