Разрешение на временное проживание

Документ‑подтверждение права иностранного гражданина временно проживать в Российской Федерации.

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

Документы для обработки должны быть закодированы в формат 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": "RVP1",
      "type": "RVP",
      "options": {
        "stages": ["verification"]
      }
    }
  ],
  "token": "<token>",
  "machine_uid": "<machine_uid>"
}

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

{
  "document_id": "s-12345"
}

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

Ключ	Описание
`project_id`	Название проекта (`U_RATE_2`)
`token`	Токен доступа (получается в разделе «Начало работы»)
`machine_uid`	Идентификатор устройства (получается в разделе «Начало работы»)
`images`	Список строк в формате base64 (файлов). Для РВП — один или несколько элементов массива (в зависимости от количества страниц/сторон документа)
`process_info`	Настройки обработки документа

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

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

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

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

import requests
import base64

# Кодируем изображение РВП в base64
with open("<путь до файла Разрешения на временное проживание>", "rb") as image_file:
    b64_rvp = 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_rvp],  # один файл — РВП
        "process_info": [
            {
                "key": "RVP1",
                "type": "RVP",
                "options": {
                    "stages": ["verification"]  # только верификация данных
                }
            }
        ]
    }
)
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-39185",
  "documents": [
    {
      "key": "RVP1",
      "type": "RVP",
      "data": {
        "Gender": "F",
        "LastName": "Иванова",
        "FirstName": "Мария",
        "MiddleName": "Петровна",
        "BirthDate": "15.03.1985",
        "BirthPlace": "г. Ташкент, Республика Узбекистан",
        "Citizenship": "Республика Узбекистан",
        "SolutionNumber": "7700-123456",
        "SolutionDate": "20.05.2023",
        "ExpiryDate": "20.05.2026",
        "IssuedBy": "ГУ МВД России по г. Москве",
        "IssueId": "77-0012345",
        "IssueDate": "25.05.2023"
      },
      "metadata": {
        "confidences": {
          "Gender": 0.9990,
          "LastName": 0.9985,
          "FirstName": 0.9992,
          "MiddleName": 0.9978,
          "BirthDate": 0.9991,
          "BirthPlace": 0.9965,
          "Citizenship": 0.9980,
          "SolutionNumber": 0.9975,
          "SolutionDate": 0.9988,
          "ExpiryDate": 0.9993,
          "IssuedBy": 0.9970,
          "IssueId": 0.9960,
          "IssueDate": 0.9982
        },
        "verifications": {
          "status": 0,
          "status_text": "ок",
          "bad_fields": []
        }
      },
      "broken": false,
      "broken_reasons": [],
      "broken_reasons_ru": []
    }
  ]
}

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

Ключ	Тип	Описание
`document_id`	string	Номер документа в формате `s-<номер документа>`
`documents`	list	Список данных по каждому документу
`documents[].key`	string	Ключ, заданный при отправке документа для отслеживания (`RVP1`)
`documents[].type`	string	Тип документа (`RVP`)
`documents[].data`	dictionary	Обработанные данные по каждому полю — содержит ключи полей и их определённые значения
`Gender`	string	Пол (`M` — мужской, `F` — женский)
`LastName`	string	Фамилия
`FirstName`	string	Имя
`MiddleName`	string	Отчество
`BirthDate`	string	Дата рождения (в формате ДД.ММ.ГГГГ)
`BirthPlace`	string	Место рождения
`Citizenship`	string	Гражданство
`SolutionNumber`	string	Номер решения о выдаче РВП
`SolutionDate`	string	Дата принятия решения о выдаче РВП (в формате ДД.ММ.ГГГГ)
`ExpiryDate`	string	Дата окончания действия разрешения (в формате ДД.ММ.ГГГГ)
`IssuedBy`	string	Наименование органа, выдавшего РВП
`IssueId`	string	Идентификатор выдачи (внутренний номер документа)
`IssueDate`	string	Дата выдачи документа (в формате ДД.ММ.ГГГГ)
`metadata`	dictionary	Содержит ключи метаданных
`confidences`	dictionary (`{key: float}`)	Метаданные с точностью обработки по каждому полю — содержит ключи полей и значения уровня уверенности. Значения от `0.0000` до `0.9999`, где чем значение больше, тем уверенность в результате выше. Максимальная уверенность — `0.9999`
`broken`	boolean	Является ли документ бракованным
`broken_reasons`	list	Список причин брака (на английском языке)
`broken_reasons_ru`	list	Список причин брака (на русском языке)