Перейти к содержанию

E-Document#

Генерация файлов электронного документа#

Важно

Данная функция предназначена для случаев, когда файлы document_pdf или document_image не были сгенерированы при первичном получении электронного документа.

В некоторых случаях при получении электронного документа файлы PDF или изображения могут не сгенерироваться. Для таких ситуаций предусмотрен специальный endpoint, позволяющий сгенерировать отсутствующие файлы.

URL запроса:

https://kyc.biometric.kz/api/v1/e-document/generate-files/

Формат запроса Метод запроса
JSON POST
Наименование поля Тип Обязательно Описание
session_id String Да UUID Flow сессии, для которой необходимо сгенерировать файлы
api_key String Да API KEY организации в личном кабинете

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

curl -X 'POST' \
  'https://kyc.biometric.kz/api/v1/e-document/generate-files/' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "session_id": "123e4567-e89b-12d3-a456-426614174000",
  "api_key": "<organization_api_key>"
}'

import requests

url = 'https://kyc.biometric.kz/api/v1/e-document/generate-files/'

headers = {
    'accept': 'application/json',
    'Content-Type': 'application/json',
}

data = {
    'session_id': '123e4567-e89b-12d3-a456-426614174000',
    'api_key': '<organization_api_key>',
}

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

print(response.status_code)

const url = 'https://kyc.biometric.kz/api/v1/e-document/generate-files/';

const headers = {
    'accept': 'application/json',
    'Content-Type': 'application/json',
};

const data = {
    'session_id': '123e4567-e89b-12d3-a456-426614174000',
    'api_key': '<organization_api_key>',
};

fetch(url, {
    method: 'POST',
    headers: headers,
    body: JSON.stringify(data)
})
.then(response => {
    console.log(response.status);
})
.catch(error => console.error(error));

Ответ:

При успешной генерации файлов возвращается статус код 200.

Примечание

  • Если оба файла (document_pdf и document_image) уже существуют, будет возвращена ошибка
  • Если файлы не могут быть сгенерированы из-за отсутствия данных в result_json, будет возвращена ошибка
  • В случае проблем с подключением к государственному сервису, будет возвращена соответствующая ошибка

Возможные ошибки:

Код состояния Ответ Описание
404 No E-Document results found for the given session Для указанной сессии не найдены результаты E-Document
404 No E-Document data found В результатах E-Document отсутствуют данные (result_json)
400 Files already exist for given E-Document Файлы уже существуют для данного E-Document
503 Can`t connect to E-Document service Не получается подключиться к государственному сервису Egov
503 E-Document service is not available now Государственный сервис Egov на данный момент не доступен
504 Could not send request to E-Document service Таймаут запроса к государственному сервису Egov