Получение данных Пользователя
в статье описан процесс получения данных Пользователя приложением Партнера
Схема получения данных пользователя в Aitu Passport
Схема процесса получения данных пользователя из Aitu Passport выглядит следующим образом:
Описание процесса получения данных пользователя из AituPassport
Пользователь инициирует процесс авторизации с помощью Aitu Passport в приложении Партнера (нажимает на кнопку или ссылку в приложении Партнера). Стрелка 1 на схеме.
В случае, если по условиям договора на оказание услуг Aitu Passport, номер мобильного телефона Пользователя верифицирует:
Партнер самостоятельно, то приложение Партнера должно в ссылке-запросе авторизации (oauth2/auth) передать параметр
otp_confirmation. Чтобы получить значение для параметраotp_confirmation, приложение Партнера должно вызвать метод api/v1/trusted-phone. Значение для параметраotp_confirmationпередается в параметреsecretответа метода api/v1/trusted-phone. Внимание!secret, а соответственно и значение в параметреotp_confirmationявляется одноразовым, его необходимо получать для каждого запроса авторизации заново!Aitu Passport, то параметр
otp_confirmationв ссылке-запросе на авторизацию (oauth2/auth) не передается, метод api/v1/trusted-phone вызывать не нужно.
Процесс получения значения для параметра
otp_confirmationобозначен стрелками 2 и 3 на схеме.
Обратите внимание:
Срок жизни OTP - 330 секунд
Максимальное количество попыток ввода OTP = 5, если они исчерпаны нужно запросить новый OTP;
OTP допускается запрашивать раз в две минуты
Количество раз отправки SMS c OTP не ограничено
Партнер генерирует ссылку-запрос авторизации. Стрелка 4 на схеме. О том, как сгенерировать ссылку-запрос авторизации и как происходит процесс авторизации см. статью "Авторизация" -> глава "Авторизация в Aitu Passport"
Пользователю отображается стартовая страница Aitu Passport c запросом на подтверждение предоставления данных приложению Партнера. Стрелки 5 и 6 на схеме.
Пользователь разрешает доступ к данным, проходит процессы авторизации, идентификации в Aitu Passport. Путь пользователя в Aitu Passport определяется параметрами переданными в ссылке-запросе авторизации и кодами услуг Aitu Passport переданными в параметре scope. Стрелки 8 - 46 на схеме.
Для успешного прохождения этапа биометрической идентификации скорость подключения устройства Пользователя к сети интернет должна быть не менее 100кб/сек
6. Aitu Passport генерирует код авторизации и передает его приложению Партнера. Описание данного процесса см. в статье "Авторизация" -> глава "Авторизация в Aitu Passport. Стрелки 47 и 48 на схеме.
7. Приложение Партнера (серверная часть приложения) обменивает полученный код авторизации на токены (access_token, id_token). Описание данного процесса см. в статье "Авторизация" -> глава "Авторизация в Aitu Passport. Стрелки 49 и 50 на схеме
Сроки действия объектов
Внимание:
Параметр
otp_confirmationдействителен в течение 60 минут с момента генерации;Код авторизации (code) действителен в течение 5 минут с момента генерации;
Токен авторизации (access_token ) действителен в течение 30 дней с момента генерации;
Токен пользователя на устройстве действителен 1 год с момента генерации.
Получение данных Пользователя
Текстовые данные
В ответе на запрос получения токенов, см., на схеме стрелки 49 и 50, помимо access_token приложение Партнера получает текстовые данные Пользователя в параметре id_token.
Параметр id_token представляет собой jwt-токен и содержит в себе все текстовые данные Пользователя, которые были запрошены в ссылке-запросе на авторизацию в параметре scope. Для того чтобы извлечь текстовые данные пользователя из id_token вы можете воспользоваться https://jwt.io/, так же на данном сайте описано, как данный jwt-токен можно распарсить в коде.
Структура текстовых данных, передаваемых в id_token:
first_name*
string
Имя Пользователя.
Передается, если в ссылке-запросе авторизации, в параметре scope передано значение first_name
last_name*
string
Фамилия Пользователя.
Передается, если в ссылке-запросе авторизации, в параметре scope передано значение last_name
middle_name*
string
Отчество Пользователя.
Передается, если в ссылке-запросе авторизации, в параметре scope передано значение middle_name и Пользователь указал отчество
birth_date*
string
Дата рождения Пользователя.
Передается, если в ссылке-запросе авторизации, в параметре scope передано значение birth_date
gender*
string
Пол Пользователя.
Передается, если в ссылке-запросе авторизации, в параметре scope передано значение gender
nickname
string
nickname (псевдоним) Пользователя. Передается если в ссылке-запросе авторизации, в параметре scope передано значение nickname
id_card_manual*
object
Объект, содержащий данные документа, удостоверяющего личность Пользователя. Передается, если в ссылке-запросе авторизации, в параметре scope, передано значение id_card_manual. Структура объекта
residence_permit_manual*
object
Объект, содержащий данные документа, вида на жительство Пользователя. Передается, если в ссылке-запросе авторизации, в параметре scope, передано значение residence_permit_manual. Структура объекта
identification_document_manual*
object
Объект, содержащий данные документа, удостоверяющего личность Пользователя. Передается, если в ссылке-запросе авторизации, в параметре scope, передано значение identification_document_manual. Структура объекта
identification_document_ocr*
object
Объект, содержащий данные документа, удостоверяющего личность Пользователя. Передается, если в ссылке-запросе авторизации, в параметре scope, передано значение identification_document_ocr. Структура объекта
identification_document_mrz*
object
Объект, содержащий данные документа, удостоверяющего личность Пользователя. Передается, если в ссылке-запросе авторизации, в параметре scope, передано значение identification_document_mrz. Структура объекта
residence_address_manual
object
Объект, содержащий адрес фактического проживания Пользователя на территории РК. Передается, если в ссылке-запросе авторизации, в параметре scope, передано значение residence_address_manual. Структура объекта
registration_address_manual
object
Объект, содержащий адрес регистрации Пользователя на территории РК. Передается, если в ссылке-запросе авторизации, в параметре scope, передано значение registration_address_manual. Структура объекта
phone
string
Номер мобильного телефона Пользователя.
Передается, если в ссылке-запросе авторизации, в параметре scope передано значение phone
sub
string
Идентификатор Пользователя в AituPasport, передается всегда. В параметра scope передано значение openid
idpc_verification*
object
Объект, который содержит данные полученные из ЦОИД при идентификации Пользователя.
allowed
boolean
Согласие пользователя на получение данных, совершение действий в кошельке Aitu Wallet 2.0.
True - Пользователь дал разрешение. False - Пользователь не дал разрешение.
Передается, если в ссылке-запросе авторизации, в параметре scope передано одно или несколько значений из списка: wallet_read, wallet_pay, wallet_history
biometryQr
boolean
Параметр передается равный TRUE если в процессе биометрической идентификации пользователю был показан QR-код со ссылкой для прохождения биометрии на другом устройстве И пользователь прошел биометрию на другом устройстве.
QR-код отображается если отсутствует доступ к камере на начальном устройстве, на котором пользователь начал проходить биометрию.
gov_doc_verification
object
Объект содержит данные удостоверения личности гражданина РК/вида на жительство иностранца выданного РК для скоупа (услуги) gov_doc_verification. Передается только в том случае, если биометрическая идентификация была пройдена Пользователем успешно. Структура объекта
confidence_level
object
Объект содержит данные о результате прохождения биометрии для скоупа (услуги) gov_doc_verification. Передается всегда если в запросе авторизации вместе со скоуп gov_doc_verification передан параметр allow_face_match_failure = True (разрешено успешно завершать оAuth сессию и передавать ключ авторизации вне зависимости от результатов биометрической идентификации). Структура объекта
Структура объектов:
international_passport_manual_3d_verification
name
Required
string
Наименование параметра
value
Required
string
Значение параметра
modified
Required
string
Признак изменения параметра
Список параметров объектов:
id_card_manual,
residence_permit_manual,
identification_document_manual,
identification_document_ocr
international_passport_manual_3d_verification
idCardNumber
Номер документа
iin
ИИН
lastName
Фамилия
firstName
Имя
patronymic
Отчество
dateOfBirth
Дата рождения
placeOfBirth
Место рождения
nation
Национальность
authority
Орган, выдавший документ
issueDate
Дата выдачи документа
expireDate
Дата завершения срока действия документа
Список параметров объекта - identification_document_mrz
idCardNumber
Номер документа
iin
ИИН
lastName
Фамилия
firstName
Имя
patronymic
Отчество
dateOfBirth
Дата рождения
placeOfBirth
Место рождения
nation
Национальность
expireDate
Дата завершения срока действия документа
Структура объектов:
residence_address_manual,
registration_address_manual
country
Required
string
Наименование страны
countryRu
Required
string
Наименование страны на русском языке
countryEng
Required
string
Наименование страны на английском языке
countryKz
Required
string
Наименование страны на казахском языке
republicRu
Required
string
Область или город республиканского значения на русском языке
regionRu
Required
string
Район или городская администрация на русском языке
districtRu
Optional
string
Город (район города) или иные поселения на русском языке
districtAdministrationRu
Optional
string
Город, городская (районная) администрация или сельский округ на русском языке
republicKz
Required
string
Область или город республиканского значения на казахском языке
regionKz
Required
string
Район или городская администрация на казахском языке
districtKZ
Optional
string
Город (район города) или иные поселения на казахском языке
districtAdministrationKz
Optional
string
Город, городская (районная) администрация или сельский округ на казахском языке
street
Required
string
Улица
building
Required
string
Номер дома
buildingAdditionalNumber
Optional
string
Дополнительный номер дома, например номер корпуса
flat
Optional
string
Номер квартиры
catfCode
Required
string
Код
Структура объекта: “idpc_verification”
iin
Required
string
ИИН пользователя, полученный из ЦОИД
requestId
Required
string
Уникальный идентификатор запроса, полученный из ЦОИД
Структура объекта: “liveness_3d”
verified
Required
boolean
Признак прохождения 3D Liveness (определения живости лица). Может принимать значения:
true - прошел успешно
false - не прошел
Структура объекта: "non_resident_data"
documentNumber
Optional
string
Номер документа нерезидента РК (номер паспорта)
iin
Optional
string
ИИН, передается при наличии
firstName
Required
string
Имя
middleName
Optional
string
Отчество, передается при наличии
lastName
Required
string
Фамилия
dateOfBirth
Required
date
Дата рождения
nation
Required
string
Страна выдачи документа (паспорта). Передается в виде ISO 3166-1 alpha-2
authority
Required
string
Орган выдавший документ (паспорт)
issueDate
Required
date
Дата выдачи документа (паспорта)
expireDate
Required
date
Дата завершения срока действия документа (паспорта)
Структура объекта gov_doc_verification для скоуп gov_doc_verification
documentNumber
Optional
string
Номер документа
iin
Optional
string
ИИН
firstName
Optional
string
Имя
middleName
Optional
string
Отчество
lastName
Optional
string
Фамилия
dateOfBirth
Optional
string
Дата рождения
placeOfBirth
Optional
string
Мессто рождения
nation
Optional
string
Гражданство
authority
Optional
string
Орган, выдавший документ
issueDate
Optional
string
Дата выдачи документа
expireDate
Optional
string
Дата завершения срока действия документа
Если вы тестируете оказание услуг по скоуп gov_doc_verification (то есть работаете с тестовой площадкой AituPassport) то вам нужно предоставить ИИН и номер мобильного телефона сотрудника который будет проводить тестирование для того чтобы добавить его данные на тестовую площадку гос., систем (тестовую БМГ, тестовую ГБД ФЛ)
Структура объекта confidence_level для скоуп gov_doc_verification
faceMatch
Параметр, определяющий прохождение биометрии:
VERIFIED - биометрия пройдена успешно
LOW_SIMILARITY - биометрия не пройдена
Например, "faceMatch":"VERIFIED"
confidenceLevel
Коэффициент схожести полученный при прохождении биометрии. Например, "confidenceLevel":0.84349,
referenceConfidenceLevel
Эталонный коэффициент схожести. Например, "referenceConfidenceLevel":0.55
Получение бинарных данных
Под получением бинарных данных подразумевается получение Партнером фото и видео материалов, сформированных Aitu Passport в процессе авторизации и идентификации Пользователя на платформе Aitu Passport.
Для получения бинарных данных в запрос, на получение этих данных, приложение Партнера должно передать Access token, в ответ Aitu Passport вернет запрашиваемые данные см., на схеме стрелки 19 и 20.
Получение фото лица Пользователя - 2D биометрическая идентификация
Получить фото лица Пользователя, сформированного при 2D биометрической идентификации можно только в том случае, если в ссылке-запросе авторизации, в параметре scope было передано значение liveness
api/v1/liveness/photo - метод получения фото лица, сформированного при 2D биометрической идентификации, описание метода см. здесь
Получение фото лица Пользователя - 3D биометрическая идентификация
Получить фото лица Пользователя, сформированного при 3D биометрической идентификации можно только в том случае, если в ссылке-запросе авторизации, в параметре scope было передано значение liveness_3d
api/v1/liveness-3d/photo - метод получения фото лица, сформированного при 3D биометрической идентификации, описание метода см. здесь
Получение фотографии документа, удостоверяющего личность Пользователя - документ загружен Пользователем самостоятельно
Получить фотографию документа, удостоверяющего личность Пользователя, которую пользователь загрузил самостоятельно в Aitu Passport можно только в том случае, если в ссылке-запросе авторизации, в параметре scope было передано одно из следующих значений:
id_card_manual
residence_permit_manual
identification_document_manual
identification_document_ocr
api/v1/documents/manual/photos - метод получения фотографии документа, удостоверяющего личность Пользователя, которую пользователь загрузил самостоятельно, описание метода см. здесь
Получение фотографии документа, удостоверяющего личность Пользователя, загруженного Пользователем самостоятельно - распознавание документа по MRZ
Получить фотографию документа, удостоверяющего личность пользователя, загруженного Пользователем самостоятельно, где распознавание данных с документа производилось через MRZ можно только в том случае, если в ссылке-запросе авторизации, в параметре scope было передано значение identification_document_mrz api/v1/documents/mrz/photo - метод получения фотографии документа, удостоверяющего личность Пользователя, которую пользователь загрузил самостоятельно, описание метода см. здесь
Получение видео-записи, снятой в процессе 3D Liveness
Получить видео-запись, снятую в процессе 3D Liveness можно только в том случае, если в вашем договоре на оказание услуг указана данная возможность и в параметре scope было передано значение liveness_3d или liveness_3d_verification. Для уточнения возможности получения данной видео-записи обратитесь к вашему проектному менеджеру.
/api/v1/liveness-3d/video - метод получения видеозаписи снятой в процессе 3D liveness, описание метода см., здесь
Получение фото документа из ГБД ФЛ
Получить фотографию документа, удостоверяющего личность пользователя можно только в том случае, если в ссылке-запросе авторизации, в параметре scope было передано значение id_card_photo
/api/v1/documents/photos - метод получения фото документа, удостоверяющего личность, описание метода см., здесь
Получение фотографии с изображением лица Пользователя (selfie)
Получить фотографию c изображением лица пользователя можно только в том случае, если в ссылке-запросе авторизации, в параметре scope было передано значение selfie.
/api/v1/profile/selfie - метод получения фото c изображением лица пользователя, описание метода см., здесь
Связанные статьи
Last updated
Was this helpful?