СНИЛС

Изображения с зелёной пластиковой карточкой — документ, подтверждающий регистрацию в системе индивидуального (персонифицированного) учёта и содержащий страховой номер индивидуального лицевого счёта (СНИЛС).

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

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

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

{
  "document_id": "s-12345"
}

---

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

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

Структура process_info

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

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

---

Пример запроса (Python) для отправки СНИЛС

import requests
import base64

# Кодируем изображение СНИЛС в base64
with open("<путь до файла СНИЛС>", "rb") as image_file:
    b64_snils = 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_snils],  # один файл — СНИЛС
        "process_info": [
            {
                "key": "SNILS1",
                "type": "SNILS",
                "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-7580",
  "documents": [
    {
      "key": "SNILS1",
      "type": "SNILS",
      "data": {
        "Number": "123-456-789 01",
        "LastName": "Иванов",
        "FirstName": "Пётр",
        "MiddleName": "Сергеевич",
        "Gender": "M",
        "BirthDate": "15.03.1990",
        "BirthPlace": "г. Москва, Российская Федерация",
        "RegistrationDate": "20.05.2015"
      },
      "metadata": {
        "confidences": {
          "Number": 0.9839,
          "LastName": 0.9999,
          "FirstName": 0.9999,
          "MiddleName": 0.9996,
          "Gender": 0.9999,
          "BirthDate": 0.9998,
          "BirthPlace": 0.9999,
          "RegistrationDate": 0.9985
        },
        "verifications": {
          "status": 0,
          "status_text": "ок",
          "bad_fields": []
        }
      },
      "broken": false,
      "broken_reasons": [],
      "broken_reasons_ru": []
    }
  ]
}

---

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

Ключ	Тип	Описание
document_id	string	Номер документа в формате s-<номер документа>
documents	list	Список данных по каждому документу
documents[].key	string	Ключ, заданный при отправке документа для отслеживания (SNILS1)
documents[].type	string	Тип документа (SNILS)
documents[].data	dictionary	Обработанные данные по каждому полю — содержит ключи полей и их определённые значения
Number	string	Страховой номер индивидуального лицевого счёта (СНИЛС), формат: XXX-XXX-XXX YY или XXX-XXX-XXXX
LastName	string	Фамилия
FirstName	string	Имя
MiddleName	string	Отчество
Gender	string	Пол (M — мужской, F — женский)
BirthDate	string	Дата рождения (в формате ДД.ММ.ГГГГ)
BirthPlace	string	Место рождения
RegistrationDate	string | null	Дата регистрации в системе индивидуального учёта (в формате ДД.ММ.ГГГГ), может быть null
metadata	dictionary	Содержит ключи метаданных
confidences	dictionary ({key: float})	Метаданные с точностью обработки по каждому полю — содержит ключи полей и значения уровня уверенности. Значения от 0.0000 до 0.9999, где чем значение больше, тем уверенность в результате выше. Максимальная уверенность — 0.9999
broken	boolean	Является ли документ бракованным
broken_reasons	list	Список причин брака (на английском языке)
broken_reasons_ru	list	Список причин брака (на русском языке)