Сканирование документа
Сервис предназначен для сканирования и распознавания документа, удостоверяющего личность: удостоверение личности гражданина РК, вид на жительство иностранца РК, международный паспорт иностранца.
Основные этапы процесса распознавания:
1) ИС партнера запрашивает токен по логину и паролю, предоставленному CID
2) ИС партнера производит старт сессии в CID по полученному токену
3) СID стартует сессию и отображает экран сканирования документа
4) Пользователь осуществляет сканирование документа, подтверждает результат распознавания
5) CID завершает сессию и передает номер сессии в ИС партнера на указанный URI
6) ИС - партнера по номеру сессии получает данные сессии (отсканированный документ и распознанные данные)
Методы взаимодействия
Получение токена
Запрос
Параметры запроса
Заголовок
identificationType
SCAN_DOCUMENT_ONLY
Да
Указатель на запуск сессии сканирования документа
redirectUri
Указывается в ИС Партнера
Да
С Партнера передает ссылку на ресурс, куда CID вернет данные сессии.
Ограничения - указанная ссылка на ресурс должна быть в списке разрешенных. Партнер за ранее должен предоставить BTSD список uri для включенния в список разрешенных
state
Указывается в ИС Партнера
Нет
Состояние системы Партнера которое будет передано CID в редиректе на ресурс ИС партнера в неизменном состоянии. Длина параметра должна быть не более 500 символов
Тело запроса
documentType
String
Да
Тип документа для сканирования:
RESIDENCE_PERMIT - Вид на жительство РК
ID_CARD - УЛ гражданина РК
INTERNATIONAL_PASSPORT - Международный паспорт
Ответ
Старт сессии
Структура запроса
Параметр
Тип
Обязательный
Описание
token
String
Yes
Токен, полученный в методе получения токена
Получение данных сессии
Запрос
Структура запроса
Параметр
Тип
Обязательный
Описание
<идентификатор сессии>
String
Yes
Уникальный идентификатор сессии в CID
String
Yes
Тип запрашиваемых данных.
identification-result - вернуть результат сессии.
В случае если сессия завершилась успешно, то ИС получит данные отсканированного документа.
В случае если сессия завершилась успешно, то ИС получит данные ошибки
Ответ
Пример - сессия завершена успешно (пользователь прошел биометрическую аутентификацию)
Пример - сессия завершена не успешно пользователь завершил сессию (пользователь не прошел биометрическую аутентификацию)
Структура ответа
Параметр
Тип
Обязательный
Описание
sessionId
String
Yes
Уникальный идентификатор сессии в CID
sessionStarted
DateTime
Yes
Дата/время начала сессии в CID
sessionEnd
DateTime
Yes
Дата/время окончания сессии в CID
sessionStatus
String
Yes
Статус сессии в CID. Может принимать следующие значения:
SUCCESS - сессия завершена успешно биометрическая аутентификация пройдена
FAILED - сессия не завершена, остановлена пользователем
document
Object
No
Данные документа, удостоверяющего личность
recognizedDocumentType
String
YES
Вид документа удостоверяющего личность. Может принимать следующие значения
RESIDENCE_PERMIT - Вид на жительство РК
ID_CARD - УЛ гражданина РК
PA - Международный паспорт
countryCode
String
YES
Код страны (ISO 3166-1 Alfa-3), выдавшей документ
Для УЛ РК и ВНЖ РК - KAZ
Для паспортов иностранцев, код указанный в их документах
documentNumber
String
YES
Номер документа
firstName
String
YES
Имя
lastName
String
YES
Фамилия
patronymic
String
NO
Отчество
gender
String
YES
Пол. Передается:
F - для женщин
M - для мужчин
dateOfBirth
Data
YES
Дата рождения
placeOfBirth
String
NO
Место рождения
nationality
String
YES
Указывается страна гражданства для документов: RESIDENCE_PERMIT и FOREIGN_PASSPORT
Указывается национальность для УЛ РК документа ID_CARD
issueDate
Data
NO
Дата выдачи
expireDate
Data
YES
Срок действия
authority
String
NO
Орган выдавший документ
identificationNumber
String
NO
ИИН
errorInfo
Object
No
Данные об ошибке
eventType
String
Yes
Событие/этап на котором произошла ошибка
error
String
Yes
Код ошибки
errorMessage
String
Yes
Текст ошибки
Ошибки
Перечень ошибок см., статью Ошибки сервисов CID
Получение медиа-данных сессии
В рамках данной сессии в CID фиксируются следующие медиа-данные
Фото отсканированного документа.
Описание методов получения медиа-данных см., статью Получение медиа-данных сессии
Last updated
Was this helpful?