MX-Document

Описание

MX-Document - это сервис-интеграция для сканирования документов, получения цифровой информации о субъекте из с государственной базы и сличения лиц субъектов, полученных после сканирования документа и извлечения информации.

Для комфортной интеграции через Backend API воспользуйтесь Swagger (OpenAPI)

---

Этапы:

1. Получение API-KEY организации

Первый этап для использования технологии - получение API-KEY организации. Чтобы получить API-KEY организации, необходимо зайти в Личный Кабинет по данной ссылке. API-KEY находится в поле Backend Api Key

Пример API-KEY организации:

API-KEY: Efy202XKbVAWRu...

Примечание

Для наглядности используется укороченная длина API KEY. Его фактическая длина составляет 47 и более символов.

2. Отправка запроса на прохождение технологии MX-Document

При отправке запроса прохождение технологии MX-Document используются данные в формате JSON.

Важно

Чтобы использовать данный сервис, необходимо иметь на него подписку. Подробнее о подписках можно прочитать здесь.

URL запроса:

https://kyc.biometric.kz/api/v1/backend/mx-document/extract-id-qr/

Формат запроса	Метод запроса
multipart/form-data	POST

API KEY необходимо передать в теле запроса:

Наименование поля	Тип	Обязательно	Описание
api_key	String	Да	API KEY организации в личном кабинете
frontside_image	File	Да	Переднее изображение документа
backside_image	File	Да	Заднее изображение документа

Примеры запроса:

cURLPythonJavaScript

    curl -X 'POST' \
    'https://kyc.biometric.kz/api/v1/backend/mx-document/extract-id-qr/' \
    -H 'accept: application/json' \
    -H 'Content-Type: multipart/form-data' \
    -F 'frontside_image=@<path_to_frontside_image;type=image/<image_extension>' \
    -F 'backside_image=@<path_to_backside_image;type=image/<image_extension>' \
    -F 'api_key=<organization_api_key>'

import requests

url = 'https://kyc.biometric.kz/api/v1/backend/mx-document/extract-id-qr/'

headers = {
    'Accept': 'application/json',
    'Content-Type': 'multipart/form-data',
}

files = {
    'frontside_image': (
        frontside_image_path,
        open(frontside_image_path, 'rb'),
        'image/<image_extension>',
    ),
    'backside_image': (
        backside_image_path,
        open(backside_image_path, 'rb'),
        'image/<image_extension>',
    ),
}

data = {
    'api_key': '<organization_api_key>',
}

response = requests.post(
    url=url,
    headers=headers,
    data=data,
    files=files,
)

print(response.json())

/*
    dependencies to install via npm: 
    form-data, fs, node-fetch
*/

import FormData from 'form-data';
import fs from 'fs';
import fetch from 'node-fetch';

const url = 'https://kyc.biometric.kz/api/v1/backend/mx-document/extract-id-qr/';
const apiKey = '<organization_api_key>';
const frontside_image_path = "<path_to_frontside_image>";
const backside_image_path = "<path_to_backside_image>";

const formData = new FormData();
formData.append('api_key', apiKey);
formData.append('frontside_image', fs.createReadStream(frontside_image_path));
formData.append('backside_image', fs.createReadStream(backside_image_path));

fetch(url, {
    method: 'POST',
    headers: {
    'accept': 'application/json',
    },
    body: formData
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error(error));

В качестве ответа придут данные, полученные из документа, в формате JSON со следующими полями:

• face_photo - фотография лица субъекта в формате base64.
• result - статус прохождения технологии.
• result_json - данные сканирования документа субъекта в формате JSON.
• qr_extraction_data - данные извлечения информации из QR-кода в формате JSON.
• qr_validation_data - данные валидации QR-кода в формате JSON.
• face_comparison_data - результат сравнения лиц, полученных в результате прохождения технологии в формате JSON.
• failure_reason - причина провала технологии.

Ошибки

Код состояния	Ответ	Описание
400	No active or future subscription for technology MX-Document	Нет активной или будущей подписки на технологию MX-Document
404	Not Found	Объект не найден (прим. Организация по указанному API-KEY)
400	MX-Document extraction failed	Базовая ошибка при распознавании документа
400	QR-code not found	QR-код не найден
400	Invalid image data provided	Не валидное изображение документа
400	Client does not have access to MX-Document technology	У клиента нет доступа к технологии. Причины: подписка отсутствует, либо она истекла, или технология не активна
400	MX-Document result already exist	Результат прохождения MX-Document уже существует
400	Subscription has not started	Подписка еще не активировалась
400	Client does not have subscription	У клиента отсутствует подписка, подробнее о подписках можно прочитать здесь
422	Validation Error	Требуемые значения не были переданы в запросе или их тип не соответствует документации
503	Cannot connect to MX-Document service	Не получается подключиться к сервису MX-Document
503	Cannot decode MX-Document response	Не удалось распознать ответ от сервиса MX-Document