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

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

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

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

Структура запроса:

url: https://api.beorg.ru/api/bescan/add_document
method: POST
headers:
    Content-Type: application/json

body:
{
    "project_id": "U_PASSPORT_AUTO",
    "images": ["<строка base64>"],
    "token": token,
    "machine_uid": machine_uid
}

|Ключ|Описание|
|-|-|
|project_id|название проекта|
|token|токен доступа|
|machine_uid|идентификатор устройства|
|images|список из строк base64 (файлов)|

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

{
    "document_id": "s-12345"
}

Ключ	Описание
document_id	идентификатор документа для отслеживания результата

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

Python

import requests
import base64

with open("<путь до файла>", "rb") as image_file:
    b64 = base64.b64encode(image_file.read()).decode()
    image_file.close()

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],
    },
)
r.json()

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

Структура запроса:

url: https://api.beorg.ru/api/document/result/s-12345?token=
methods: GET, POST

• Python

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

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

{
    "document_id": "s-12345",
    "data": {
        "IssuedBy": "IssuedBy",
        "IssueDate": "",
        "IssueId": "IssueId",
        "Series": "Series",
        "Number": "Number",
        "Gender": "Gender",
        "LastName": "LastName",
        "FirstName": "FirstName",
        "MiddleName": "MiddleName",
        "BirthDate": "",
        "BirthPlace": "BirthPlace",
        "HasPhoto": true,
        "HasOwnerSignature": true,
        "HasStamp": ""
    },
    "metadata": {
        "confidences": {
            "IssuedBy": "0.9999",
            "IssueDate": "0.9999",
            "IssueId": "0.9999",
            "Series": "0.9999",
            "Number": "0.9999",
            "Gender": "0.9999",
            "LastName": "0.9999",
            "FirstName": "0.9999",
            "MiddleName": "0.9999",
            "BirthDate": "0.9999",
            "BirthPlace": "0.9999",
            "MRZ1": "0.9999",
            "MRZ2": "0.9999",
            "HasPhoto": "0.9999",
            "HasOwnerSignature": "0.9999"
        }
    },
    "verifications": {
        "status": 0,
        "status_text": "ок",
        "bad_fields": []
    }
}

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

Ключ	Тип	Описание
document_id	string	номер документа в формате s-<номер документа>
documents	list	список данных по каждому документу
documents[].key	string	ключ заданный при отправке документа для отслеживания
documents[].type	string	тип документа
documents[].data	dictionary	обработанные данные по каждому полю, содержит ключи полей и их определенные значения
IssuedBy	string	кем выдан паспорт
IssueDate	string	дата выдачи паспорта
IssueId	string	код подразделения
Series	string	серия паспорта с первого разворота
Number	string	номер паспорта с первого разворота
Gender	string	пол
LastName	string	фамилия
FirstName	string	имя
MiddleName	string	отчество
BirthDate	string	дата рождения
BirthPlace	string	место рождения
HasPhoto	boolean или string	попала ли в кадр фотография владельца
HasOwnerSignature	boolean или string	попала ли в кадр подпись владельца
MRZ1	string	первая строка машиночитаемой записи
MRZ2	string	вторая строка машиночитаемой записи
metadata	dictionary	содержит ключи метаданных
confidences	dictionary {key: float}	метаданные с точностью обработки по каждому полю - содержит ключи полей и значения уровня уверенности. Значения от 0.0000 до 0.9999, где чем значение больше, тем уверенность в результате выше. Максимальная уверенность - 0.9999.
verifications	dictionary {key: boolean, key: integer}	метаданные совершенных проверок - содержит ключи и их значения проверок, см. Правила проверок