Створюйте безпечні запити на перевірку особи за допомогою NFC безпосередньо у вашій системі. Запрошуйте користувачів електронною поштою або SMS, або надішліть згенероване посилання самостійно. Користувач сканує NFC-чіп у мобільному додатку, а ви отримуєте лише ті дані, які необхідні для вашого процесу.
ID Scan призначений для постачальників програмного забезпечення та організацій, які бажають впровадити функцію перевірки особи, не створюючи самостійно повного мобільного процесу сканування.
Створіть запит на сканування у вашій серверній частині. Вкажіть зовнішнє посилання, мову, термін дії, параметри доставки, необхідні поля та перевірки.
Дозвольте ID Scan надіслати електронного листа або SMS, або скористайтеся власним каналом зв’язку з отриманим посиланням для підтвердження.
Користувач відкриває мобільний додаток, сканує MRZ, зчитує дані з NFC-чіпа та, за бажанням, проходить перевірку за допомогою селфі в режимі реального часу, порівнюючи його з портретною фотографією DG2.
Отримати стан, перевірки, запитувані поля та аудиторську інформацію через API. Повертаються лише налаштовані поля.
Запити до API надсилаються на базову URL-адресу API ID Scan і проходять автентифікацію за допомогою ключа API, згенерованого на порталі ID Scan. Ключ API надсилається у спеціальному заголовку запиту і повинен використовуватися виключно на стороні сервера. Ніколи не слід розкривати ключі API у коді інтерфейсу користувача або мобільних додатках.
Після створення запиту на сканування API повертає ідентифікатор запиту, ключ запиту, час дії та посилання для підтвердження. Використовуйте отримане посилання WebUrl у своїх електронних листах, SMS-повідомленнях, на порталі або в робочому процесі під час самостійної доставки. На мобільних пристроях посилання DeepLinkUrl дозволяє безпосередньо відкрити додаток.
Ви можете вибрати, яким чином користувач отримає запит на підтвердження. Це дозволяє ID Scan інтегруватися як у повністю автоматизовані, так і в індивідуальні комунікаційні процеси.
ID Scan надсилає фірмове запрошення електронною поштою із захищеним посиланням для підтвердження.
ID Scan надсилає посилання для підтвердження у SMS-повідомленні. Це зручно для процесів реєстрації, орієнтованих на мобільні пристрої.
Ваша система отримує посилання та надсилає його через вашу електронну пошту, SMS, портал або систему обміну повідомленнями.
Запит на перевірку проходить через кілька етапів обробки. Інтеграції можуть використовувати ці етапи для відображення ходу обробки, надсилання нагадувань або прийняття рішення про необхідність створення нового запиту.
| Статус | Опис |
|---|---|
requested | The request has been created and is waiting for the user to start or complete the verification. |
completed | The user completed the flow. Use IsSuccess and the check fields to determine whether verification passed. |
expired | The request expired before the user completed the verification. |
deleted | The request was deleted and is no longer available for completion. |
failed | The request could not be completed successfully because of an error or failed verification step. |
Використовуйте зовнішній ідентифікатор, щоб пов’язати запит на перевірку зі своїм клієнтом, співробітником, досьє, замовленням або записом про реєстрацію. Цей самий ідентифікатор повертається під час отримання деталей запиту.
Прив’яжіть запит до запису про вашого клієнта.
Прив’яжіть результат до справи Wwft, кадрової справи або справи з питань дотримання нормативних вимог.
Використовуйте посилання, щоб продовжити автоматизовані робочі процеси після завершення перевірки.
ID Scan підтримує принцип мінімізації даних. Ви можете налаштувати, які саме поля мають передаватися до вашої системи. Користувачеві можна показати, які дані будуть передані, ще до відправлення запиту.
| Поле | Опис | Джерело |
|---|---|---|
surname | Surname / family name from the identity document. | NFC DG1 |
given_names | Given names from the identity document. | NFC DG1 |
date_of_birth | Date of birth. Can also be used for age checks. | NFC DG1 |
date_of_expiry | Document expiry date. | NFC DG1 |
document_number | Document number. Can be returned full or masked depending on template settings. | NFC DG1 |
document_type | Document type, such as passport or identity card. | NFC DG1 |
issuing_country | Country that issued the document. | NFC DG1 |
country_of_issue | Country of issue when available. | NFC DG1 |
nationality | Nationality from the identity document. | NFC DG1 |
gender | Gender marker from the document, if requested. | NFC DG1 |
photo | Portrait photo from the NFC chip. Only return when explicitly needed. | NFC DG2 |
mrz_masked_image | Masked MRZ image as proof of scan without exposing all MRZ data. | Camera/MRZ |
selfie_image | Live selfie image. Usually only included for manual review. | Camera/selfie |
Перевірки можна ініціювати в рамках процедури верифікації. Деякі з них — це технічні перевірки NFC, а інші — перевірки на відповідність бізнес-правилам, наприклад, щодо мінімального віку або верифікації за допомогою селфі.
| Перевірити | Опис | Отриманий результат |
|---|---|---|
nfc_read_success | Indicates whether the NFC chip was successfully read. | true / false |
chip_authentication_success | Indicates whether chip authentication or chip verification succeeded. | true / false |
document_not_expired | Checks if the document expiry date is in the future. | true / false |
minimum_age | Checks whether the person meets a configured minimum age without necessarily returning the date of birth. | { required, passed } |
sod_signature_valid | Checks the SOD signature when available. | true / false |
dg1_hash_valid | Checks whether DG1 data matches the signed document data. | true / false |
dg2_hash_valid | Checks whether the portrait photo data matches the signed document data. | true / false |
active_auth_ok | Optional active authentication result when supported by the document. | true / false / not available |
selfie_check | Optional live selfie verification matched against the DG2 portrait photo. | { requested, consent_given, passed, status, method } |
Кінцева точка результату повертає статус запиту, статус перевірки, зовнішнє посилання, вибрані поля ідентифікації, вибрані зображення та результати перевірки. Поля, які не були запитані, не повертаються.
Запитані, виконані, з терміну дії, видалені або з помилкою, включаючи мітки часу створення та виконання.
Лише налаштовані ідентифікаційні дані, такі як ім’я, громадянство, дата народження або термін дії документа.
Статус зчитування NFC, автентифікація чіпа, термін дії документа, перевірка за допомогою селфі та додаткові дані у форматі PDF/звітів.
Такі поля зображень, як портретна фотографія DG2, зображення MRZ із маскою та селфі, при запиті повертаються у вигляді даних, закодованих у форматі Base64. Зображення не повертаються у вигляді загальнодоступних URL-адрес.
Використовуйте значення даних як бінарні дані зображення, закодовані у форматі Base64.
Використовуйте атрибут content_type, наприклад image/jpeg, щоб правильно відтворити зображення.
Дані зображення включаються лише в тому випадку, якщо це поле явно вказано в шаблоні.
Номер документа може бути наданий у повному вигляді або в замаскованому вигляді. Замаскування допомагає уникнути непотрібного розголошення номерів документів, водночас залишаючи можливість проводити зіставлення або аудиторські перевірки у вашій системі.
| Значення | Опції | Опис |
|---|---|---|
(empty) | No masking | Return the document number as read from the identity document. Only use when the full document number is required. |
last4_visible | Last 4 visible | Mask the document number and only return the last four characters, for example *****7P44. |
first4_visible | First 4 visible | Mask the document number and only return the first four characters. |
У наведеному нижче прикладі створюється запит на перевірку, надсилається запит до ID Scan на відправлення запрошення електронною поштою, а також повертаються лише вибрані поля та результати перевірки.
Після завершення ваша система зможе отримати результат за ідентифікатором запиту або ключем запиту. Зовнішнє посилання можна використовувати для інтеграції результату у вашу систему.
Параметри зберігання даних можна налаштовувати для кожного окремого клієнта. Дані для верифікації можна видаляти через певний проміжок часу, після їхнього перегляду або відповідно до налаштованої політики конфіденційності. Це допомагає обмежити непотрібне зберігання конфіденційних даних про особу.
Видалити дані перевірки через задану кількість днів.
Позначити дані як прочитані після їх отримання та запланувати їх видалення після цього.
За потреби використовуйте окремі налаштування зберігання даних для робочих процесів порталу та API.
Окрім створення та вилучення запитів, інтеграції можуть повторно надсилати запрошення або видаляти запити. Видалення запиту може знадобитися, якщо робочий процес скасовано або перевірка більше не потрібна.
POST /api/scan-requests/{id}/resend
DELETE /api/scan-requests/{id}
GET /api/scan-requests/{id}/details
Тестовий режим можна використовувати для перевірки всього процесу інтеграції перед запуском у виробництво. Тестові запити позначаються атрибутом IsTest у відповіді API, що дозволяє вашій системі відокремлювати тестові дані від робочих процесів у виробничому середовищі.
Перевіряйте створення запитів, їх надсилання, сканування додатків та отримання результатів без використання робочих процесів у виробничому середовищі.
Відповідь на запит створення містить атрибут IsTest, що дозволяє легко виявляти тестові запити.
Почніть із налаштування тестового ключа API або тестового клієнта, а після перевірки перейдіть до реальної верифікації.
Не кожен запит завершується успішною верифікацією. Користувач може перервати процес, термін дії запиту може закінчитися або зчитування за допомогою NFC може завершитися невдачею. Для визначення кінцевого результату використовуйте параметри Status, HasResult, IsSuccess та поля перевірки.
Створіть безкоштовний обліковий запис, згенеруйте ключ API та протестуйте весь процес перед запуском у виробництво.