New: Extract data from any document with AI. Meet AnyDoc.
Check it out
Ctrlk
Contact us
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Посібник для розробників

Посібник для розробників надає вичерпні інструкції та найкращі практики для інтеграції з нашою платформою.

Identomat — це сервіс, розроблений для перевірки особи людини та живості через Інтернет. Цей посібник передбачає, що інтегруюча організація (далі — «компанія») має вебсервер (далі — «сервер компанії») за адресою example.com.

Передумови

Перед інтеграцією компанія має отримати company_key — облікові дані, що використовуються для безпечної комунікації між сервером компанії та сервером Identomat (widget.identomat.com).

Ще немає company_key? Дивіться Доступ до API, щоб дізнатися, як згенерувати його з вашої панелі керування Identomat.

Необов'язкові функції безпеки, що налаштовуються під час генерації ключа або в будь-який час пізніше:

  • HMAC-авторизація — secret_key використовується для генерації та перевірки HMAC-підписів, додаючи додатковий рівень верифікації для запитів, надісланих із вашим company_key.

  • Білий список IP-адрес — Обмежте company_key конкретним набором IP-адрес. Після додавання IP-адрес приймаються лише запити з цим ключем із адреси, що входить до білого списку; запити з будь-якої іншої IP-адреси відхиляються. Якщо список залишити порожнім, ключ можна використовувати з будь-якої IP-адреси. Обидва налаштування можна додавати, редагувати чи видаляти в будь-який час у тому ж розділі вашої панелі керування, де було згенеровано ключ.

Для підвищення безпеки компанії можуть за бажанням реалізувати HMAC-авторизацію. У цьому випадку secret_key використовується для генерації та перевірки HMAC-підписів для безпечної комунікації.

Процедура

Процедура інтеграції складається з трьох основних кроків:

Отримання токена сесії

Щоб отримати session_token, ваш бекенд має надіслати запит до ендпоінту /begin/ із такими параметрами:

  • company_key – Ваш унікальний ідентифікатор компанії.

  • flags – Об'єкт JSON, що визначає глобальні налаштування для сесії верифікації.

  • steps – Масив, що вказує кроки, які потрібно включити у потік верифікації. Кожен крок може мати власні прапорці (flags), специфічні для цього кроку.

⚠️ session_token дійсний протягом 15 хвилин за замовчуванням.

Ендпоінт:

Запити можна надсилати як:

  • Параметри URL-запиту

  • Дані форми, закодовані в URL

  • Об'єкт JSON у тілі запиту (рекомендовано)

Структура Steps та Flags

  • flags: Визначає глобальну поведінку для всієї сесії.

  • steps: Дозволяє повний контроль над процесом верифікації, надаючи можливість вказати які кроки включити (наприклад, liveness, identity-document) та налаштувати прапорці, специфічні для кроку, такі як "allow_face_upload": true для кроку liveness.

Щоб забезпечити сумісність між старим та новим методами, які мають працювати разом, вам слід використовувати прапорці 'skip_face' та 'skip_document' при використанні steps.

Ці прапорці запобігають дублюванню кроків 'identity-document' та 'liveness', якщо вони вже існують у потоці.

Використання конфігурації або власних кроків

Ви можете ініціювати сесію двома способами:

  • Через попередньо визначену конфігурацію (рекомендовано):

    • Ми наполегливо рекомендуємо використовувати попередньо визначені конфігурації через параметр config_id. Конфігурації забезпечують узгодженість, спрощують інтеграцію та зменшують ризик помилок. Використання конфігурацій також дозволяє нам у майбутньому припинити підтримку застарілої обробки власних кроків, допомагаючи клієнтам підтримувати чисту та стабільну інтеграцію.

  • Через власні кроки та прапорці: Використовуйте власні кроки та прапорці лише якщо у вас є дуже специфічні потреби, які неможливо задовольнити за допомогою конфігурацій. Із часом ми рекомендуємо переносити всі власні потоки на конфігурації.

Чому конфігурації важливі:

  • Спрощує створення сесії — не потрібно вручну визначати кроки та прапорці.

  • Зменшує ризик помилок у потоці верифікації.

  • Захищено від застарівання — застаріла обробка власних кроків з часом буде припинена.

  • Дозволяє Identomat ефективно підтримувати, покращувати та оптимізувати потоки.

  • Полегшує інтеграцію.

📘 Для детальних визначень параметрів та прикладів див. Довідник API.

Перенаправлення на віджет Identomat

Щоб розпочати сесію верифікації, сервер компанії має перенаправити браузер користувача на:

Замініть {session_token_here} на фактичний токен, отриманий від ендпоінту /begin/.

Вбудовування в Iframe

Альтернативно, віджет можна вбудувати в iframe:

Атрибут allow="camera" є обов'язковим для надання доступу до камери. Без нього кроки верифікації, що залежать від камери, не працюватимуть.

Перевірка результату

Після завершення процесу верифікації результат можна визначити двома способами, залежно від того, як було інтегровано віджет:

  • Якщо використовується перенаправлення Якщо ви використовували підхід із перенаправленням (не вбудований в iframe), користувача буде перенаправлено на return_url, вказаний у налаштуваннях конфігурації чи прапорцях сесії, із доданим параметром запиту session_token.

  • Якщо вбудовано в iframe, завершення процесу можна визначити за допомогою JavaScript:

Обов'язково перевіряйте origin повідомлення, щоб уникнути ризиків безпеки.

Швидкі посилання

Отримайте доступ до детальних посібників для розробників щодо потоків KYC (Know Your Customer) та KYB (Know Your Business). Натисніть на картку нижче, щоб дослідити конфігурацію, кроки інтеграції та найкращі практики для кожного типу верифікації.

KYC (Know Your Customer) Дізнайтеся, як збирати та перевіряти дані окремих користувачів, налаштовувати кроки верифікації та інтегрувати потоки KYC.

KYB (Know Your Business)

Дізнайтеся, як збирати та перевіряти дані компанії, бенефіціарів та представників, за допомогою настроюваних кроків верифікації.

PreviousКроки KYB
NextKYC (Know Your Customer)

Last updated

Was this helpful?