Водительское удостоверение

Описание

Driver License — это сервис для проверки наличия водительского удостоверения у гражданина Республики Казахстан по его индивидуальному идентификационному номеру (ИИН).

Для комфортной интеграции через 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. Отправка запроса на проверку водительского удостоверения

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

Важно

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

URL запроса:

https://kyc.biometric.kz/api/v1/backend/driver-license/request/

Формат запроса	Метод запроса
JSON	POST

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

Наименование поля	Тип	Обязательно	Описание
api_key	String	Да	API KEY организации в личном кабинете
iin	String	Да	ИИН субъекта

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

cURLPythonJavaScript

    curl -X 'POST' \
    'https://kyc.biometric.kz/api/v1/backend/driver-license/request/' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
    "api_key": "<organization_api_key>",
    "iin": "<subjects_iin>"
    }'

import requests

url = 'https://kyc.biometric.kz/api/v1/backend/driver-license/request/'

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

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

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

print(response.json())

const url = 'https://kyc.biometric.kz/api/v1/backend/driver-license/request/';

const apiKey = '<organization_api_key>';

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

const data = {
    api_key: apiKey,
    iin: '<subjects_iin>',
};

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

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

• backend_session_id - Идентификатор Backend-сессии
• status - Статус обработки запроса (по умолчанию: PENDING)
• iin - ИИН субъекта
• result - Результат проверки наличия водительского удостоверения (true / false / null)

Примечание

Возможные значения поля status:

• PENDING — запрос в обработке
• VALID — водительское удостоверение найдено
• INVALID — водительское удостоверение не найдено
• FAILED — ошибка при обработке запроса

Пример ответа:

{
  "backend_session_id": "9e2d5632-df64-4a1f-9b6c-d7d2ad79742f",
  "status": "VALID",
  "iin": "950215301234",
  "result": true
}

Ошибки

Код состояния	Ответ	Описание
400	Subscription has not started	Подписка еще не активировалась
400	No active or future subscription for technology	Нет активной или будущей подписки на технологию
400	Client does not have subscription	У клиента отсутствует подписка, подробнее о подписках можно прочитать здесь
400	Client does not have access to Driver License technology	У клиента нет доступа к технологии. Причины: подписка отсутствует, либо она истекла, или технология не активна
404	Organization not found	Не найдена организация по предоставленному API key
503	Driver License service is not available now	Сервис Driver License в данное время не доступен