Начало работы
Что нужно для старта
Перед началом убедитесь, что у вас есть:
-
Аккаунт:
Зарегистрируйтесь на kyc.beorg.ru/self_sign (это займет 2 минуты).
-
Технические требования:
- доступ к интернету
- любой язык программирования (например, Python, JavaScript, PHP).
-
Файлы для теста:
Подготовьте изображения документов подходящие под требования к изображениям Пример: Сфотографируйте паспорт на белом столе при хорошем освещении.
Пошаговое руководство для распознавания документов
Следуйте этим шагам, чтобы начать использовать Beorg API для распознавания документов:
-
Получите ключи API
-
После регистрации зайдите в раздел Доступы к API - kyc.beorg.ru/projects.
-
Скопируйте c этой страницы
- token
- machine_uid
- project_id
Совет: Сохраните ключи в безопасном месте и не передавайте их третьим лицам.
-
-
Настройте запросы к API
-
Схема работы с API
-
Пример алгоритма на Python:
import requests import base64 from time import sleep PATH_TO_IMAGE_1 = "<путь до изображения паспорта 2-3 страница>" PATH_TO_IMAGE_2 = "<путь до изображения паспорта страница с регистрацией>" PROJECT_ID = "<project_id>" TOKEN = "<token>" MACHINE_UID = "<machine_uid>" # вид документа TYPE = "PASSPORT_REG" # изображение паспорта 2-3 страница в base64 with open(PATH_TO_IMAGE_1, "rb") as image_file: image1 = base64.b64encode(image_file.read()).decode() image_file.close() # изображение паспорта страница с регистрацией в base64 with open(PATH_TO_IMAGE_2, "rb") as image_file: image2 = base64.b64encode(image_file.read()).decode() image_file.close() # отправляем изображения документа document = requests.post( "https://api.beorg.ru/api/bescan/add_document", headers={"Content-Type": "application/json"}, json={ "token": TOKEN, "project_id": PROJECT_ID, "machine_uid": MACHINE_UID, "images": [image1, image2], "process_info": [ { "type": "PASSPORT_REG", "key": "PASSPORT_REG1" }, { "type": "PASSPORT_REG", "key": "PASSPORT_REG1" } ] }, ) # достаем из ответа номер для отслеживания document_id = document.json().get("document_id") print(f"Номер для отслеживания: {document_id}") if document_id is not None: # опрашиваем API пока не получим результат result_req = requests.get( f"https://api.beorg.ru/api/document/result/{document_id}?token={TOKEN}" ) while result_req.status_code != 200: print("Документ обрабатывается") sleep(1) result_req = requests.get( f"https://api.beorg.ru/api/document/result/{document_id}?token={TOKEN}" ) # достаем данные из ответа API result = result_req.json() print("/////////////////////") print("Результат:") print(result) -
Для непрограммистов: В личном кабинете перейдите в раздел Распознавание и загрузите документы через интерфейс - https://kyc.beorg.ru/loading.
Для настройки иной конфигурации тела запроса или добавления опций при обработке (например улучшенное качество) перейдите в пункт Шаги для конфигурирования тела запроса
-
-
Отправьте тестовый документ
Убедитесь, что изображение соответствует требованиям (четкие края, без фона, формат JPG/PNG).
Загрузите изображение документа (например, паспорт) через API или личный кабинет.
-
Проверьте результат
API вернет данные в формате JSON, содержащие извлеченные данные, например:
{ "document_id": "s-12345", "documents": [ { "key": "PASSPORT_REG1", "type": "PASSPORT_REG", "data": { "IssuedBy": "IssuedBy", "IssueDate": "", "IssueId": "IssueId", "Series": "Series", ... } } ] }Проверьте, что данные корректны. Если результат неточный (например, пропущены поля), убедитесь, что изображение четкое, или попробуйте другое фото.
Совет: Сохраните ответ API для анализа или интеграции в вашу систему.
-
Что дальше?
- Масштабирование
- Интеграция: Подключите API к вашей системе, например: 1С. Для нестандартных интеграций напишите на kyc@beorg.ru.
-
Поддержка: Поддержка осуществляется в рабочие дни, с 9.00 до 19.00 по Москве.
- По вопросам стоимости и условий продажи лицензий: kyc@beorg.ru
- По вопросам технической поддержки: tech.support@beorg.ru
Шаги для конфигурирования тела запроса
Следуйте этим шагам, чтобы создать собсвенную конфигурацию тела запроса распознавания документов:
Вы можете получить шаблон тела запроса из раздела Распознавание - https://kyc.beorg.ru/loading для этого:
- Выберите необходимый тип документа
- Нажмите снизу формы отправки документа на кнопку с пиктограммой "?"
- Скопируйте шаблон тела запроса
- Измените в нем данные на свои
- Используйте тело в запросе
Если шаблоны из раздела Распознавание не подходят сделайте следующие шаги:
-
Укажите доступы
Указываются в формате:
"token": "<token>", "machine_uid": "<machine_uid>", "campaign_id": "<project_id>"Используются для авторизации запроса с целью защиты от несанкционированного доступа.
Для получения доступов обратитесь к Пошаговому руководствy для распознавания документов
Не передавайте token и machine_uid третьим лицам, а также на сторону Вашего клиента
-
Укажите изображения
Указываются в формате:
"images": [ "<строка base64>", "<строка base64>", ... "<строка base64>" ]Изображения передаются в формате base64 и должны соответствовать требованиям к изображениям
Обратите внимание, что очередность строк base64 должна соответстовать следующему пункту (process_info)
-
Сконфигурируйте обработку каждого изображения
Конфигурация указывает какие изображения связаны между собой, какие опции используются при обработке, а также к какому конкретно типу и сущности относятся при изображения при обработке
Указывается в формате:
"process_info": [ { "type": "<тип>", "key": "<свободный ключ>", "options": {опции при обработке} }, { "type": "<тип>", "key": "<свободный ключ>", "options": {опции при обработке} }, ... { "type": "<тип>", "key": "<свободный ключ>", "options": {опции при обработке} } ]Обратите внимание, что количество и порядок записей в ключе process_info должно строго соответствовать количеству записей и порядку в ключе images
Рассмотрим ключи для каждого изображения:
-
type - ключ типа документа (PASPORT, PASSPORT_REG, DLIC...) Все доступные ключи документов можно уточнить в таблицах в разделах Тариф Биорг.Универсальный и Тариф Биорг.KYC
-
key - свободный ключ (можете указать любое строковое значение) для того, чтобы связать 2 и более изображений в одну сущность/документ
-
options - опции при обработке документа Все доступные опции описаны в разделах Сценарии обработки (Биорг.Универсальный) и Сценарии обработки (Биорг.KYC)
-
Пример
Рассмотрим пример тела запроса для обработки водительского удостоверения совместно со сверкой селфи.
{
"token": "<token>",
"machine_uid": "<machine_uid>",
"campaign_id": "<project_id>",
"images": [
"<строка base64 изображения лицевого разворота ВУ>",
"<строка base64 изображения заднего разворота ВУ>",
"<строка base64 селфи>"
],
"process_info": [
{
"type": "DLIC",
"key": "DRIVER_LICENSE",
"options": {
"relation": {
"biometry_match": "SELFIE"
},
"stages": [
"verification",
"biometry_match"
]
}
},
{
"type": "DLIC",
"key": "DRIVER_LICENSE",
"options": {
"relation": {
"biometry_match": "SELFIE"
},
"stages": [
"verification",
"biometry_match"
]
}
},
{
"type": "SELFIE",
"key": "SELFIE",
"options": {
"stages": [
"biometry_liveness"
]
}
}
]
}
В представленном выше теле запроса указаны:
-
ключи доступа
"token": "<token>", "machine_uid": "<machine_uid>", "campaign_id": "<project_id>"Для получения доступов обратитесь к шагу 1 Пошагового руководства для распознавания документов
-
3 изображения
"images": [ "<строка base64 изображения лицевого разворота ВУ>", "<строка base64 изображения заднего разворота ВУ>", "<строка base64 селфи>" ] -
конфигурация для каждого из изображений
"process_info": [ { "type": "DLIC", "key": "DRIVER_LICENSE", "options": { "relation": { "biometry_match": "SELFIE" }, "stages": [ "verification", "biometry_match" ] } }, { "type": "DLIC", "key": "DRIVER_LICENSE", "options": { "relation": { "biometry_match": "SELFIE" }, "stages": [ "verification", "biometry_match" ] } }, { "type": "SELFIE", "key": "SELFIE", "options": { "stages": [ "biometry_liveness" ] } } ]В первом и втором элементаъ указано, что первое и второе изображение из images лицевого разворота ВУ будут иметь тип обработки DLIC - водительское удостоверение.
В опциях элементов по ключу relation указано, что документ логически связан с обработкой изображения SELFIE на этапе сверки лиц.
В этих же опциях по ключу stages указано, что изображение будет использовать 2 опции: - verification - улучшенное качество обработки - biometry_match - сверка лиц на двух изображениях
Обратите внимание, что первый и второй элемент содержат одинаковый ключ key - DRIVER_LICENS". Это означает, что первое и второе избражение из images относятся к одному документу и в ответе буду представлены как один документ.
В третьем элементе указано, что третье изображение из images будет иметь тип обработки SELFIE - Селфи.
В опциях третькго элемента по ключу stages указано, что изображение селфи будет использовать опции: - biometry_liveness - проверка на живость