Свидетельство о браке

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

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

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

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

Заголовки:

Content-Type: application/json

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

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

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

{
  "document_id": "s-12345"
}

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

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

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

Ключ	Описание
`key`	Свободный ключ для разделения документов при загрузке и получении результатов. Если не указан, вместо него используется ключ `type`
`type`	Тип документа (`MRG`)
`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": "MRG1",
                "type": "MRG"
            }
        ]
    }
)
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-39127",
  "documents": [
    {
      "key": "MRG1",
      "type": "MRG",
      "data": {
        "HusbandLastName": "Иванов",
        "HusbandFirstName": "Иван",
        "HusbandMiddleName": "Иванович",
        "HusbandBirthDate": "10.03.1985",
        "WifeLastName": "Петрова",
        "WifeFirstName": "Мария",
        "WifeMiddleName": "Сергеевна",
        "WifeBirthDate": "15.05.1992",
        "MarriageDate": "20.07.2013",
        "Series": "I‑AB",
        "Number": "123456"
      },
      "metadata": {
        "confidences": {
          "HusbandLastName": 0.97,
          "HusbandFirstName": 0.98,
          "WifeLastName": 0.96,
          "WifeFirstName": 0.95,
          "MarriageDate": 0.99,
          "Series": 0.94,
          "Number": 0.98
        },
        "verifications": {
          "marriage_date_valid": true
        }
      },
      "broken": false,
      "broken_reasons": [],
      "broken_reasons_ru": []
    }
  ]
}

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

Ключ	Тип	Описание
`document_id`	string	Номер документа в формате `s-<номер документа>`
`documents`	list	Список данных по каждому документу
`documents[].key`	string	Ключ, заданный при отправке документа для отслеживания
`documents[].type`	string	Тип документа (`MRG`)
`documents[].data`	dictionary	Обработанные данные по каждому полю — содержит ключи полей и их определённые значения
`HusbandLastName`	string	Фамилия мужа
`HusbandFirstName`	string	Имя мужа
`HusbandMiddleName`	string	Отчество мужа
`HusbandBirthDate`	string	Дата рождения мужа
`WifeLastName`	string	Фамилия жены
`WifeFirstName`	string	Имя жены
`WifeMiddleName`	string	Отчество жены
`WifeBirthDate`	string	Дата рождения жены
`MarriageDate`	string	Дата заключения брака
`Series`	string	Серия свидетельства о браке
`Number`	string	Номер свидетельства о браке
`metadata`	dictionary	Содержит ключи метаданных
`confidences`	dictionary (`{key: float}`)	Метаданные с точностью обработки по каждому полю — содержит ключи полей и значения уровня уверенности. Значения от `0.0000` до `0.9999`, где чем значение больше, тем уверенность в результате выше. Максимальная уверенность — `0.9999`
`broken`	boolean	Является ли документ бракованным
`broken_reasons`	list	Список причин брака (на английском языке)
`broken_reasons_ru`	list	Список причин брака (на русском языке)