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.

Довідник API

Документація довідника API надає детальну інформацію про доступні ендпоінти, параметри запитів, формати відповідей та методи автентифікації для інтеграції з Identomat.

Ліміт запитів

Для захисту стабільності системи та запобігання зловживанням наш API застосовує обмеження швидкості запитів:

  • Ліміт: Максимум 600 запитів за хвилину з однієї IP-адреси.

  • Перевищення ліміту: Якщо IP-адреса перевищує цей поріг, вона буде тимчасово заблокована на 1 годину.

  • Відповідь про помилку: Протягом періоду блокування всі запити з заблокованої IP-адреси повертатимуть помилку 529 Too many requests.

Керування сесіями

Використовуйте ці ендпоінти для створення сесій верифікації та керування ними. Сесії можна запускати за допомогою збереженої конфігурації (рекомендовано) або з власними кроками та прапорцями.

begin/ - Створення сесії (застаріле)

URL:

https://widget.identomat.com/external-api/begin/

Опис:

Ініціює нову сесію верифікації. Сесії можна запускати або за допомогою попередньо визначеної конфігурації (config_id), або явно вказавши кроки та прапорці для власного потоку.

Цей ендпоінт тепер також підтримує перевизначення окремих кроків у межах конфігурації. Це дозволяє вводити динамічні дані (наприклад, попередньо заповнювати дані користувача, як-от ім'я та прізвище), продовжуючи використовувати вашу збережену конфігурацію, роблячи перехід до налаштувань на основі конфігурацій більш гнучким.

Параметри:

  • company_key (string, обов'язковий)- Секретний ключ компанії.

  • parent_session_id (string, необов'язковий) – Вказує ID батьківської сесії при створенні дочірньої сесії для верифікації з декількома учасниками.

разом з:

  • config_id (string, необов'язковий) - Унікальний ідентифікатор конфігурації сесії.

або:

  • flags (object, необов'язковий) – Об'єкт JSON, що містить опції налаштування сесії.

  • steps (array, необов'язковий) – Визначає послідовність кроків у процесі ідентифікації.

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

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

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

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

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

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

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

Приклад cURL:

curl https://widget.identomat.com/external-api/begin/ \
    -F 'company_key=your-company-secret-key' \
    -F 'config_id=62412c096c4b39ba845d4bf2'

Перегляньте всі приклади кроків у Посібнику для розробників.

Приклади параметрів запиту:

Запустити сесію за замовчуванням:

{
  "company_key": "your-company-secret-key"
}

Запустити сесію з конфігурацією (рекомендовано):

{
  "company_key": "your-company-secret-key",
  "config_id": "62412c096c4b39ba845d4bf2"
}

Запустити сесію з прапорцями та кроками:

{
  "company_key": "your-company-secret-key",
  "flags": {},
  "steps": [],
  "parent_session_id": "98aryxvvzwpi4zuasth332ozfucli3l0qx13hisc"
}

Приклади результату:

за замовчуванням:

"47fjzxvvzapi4ztasth3c2ozfucli3l0qx13hisc"

Поведінка перевизначення конфігурації

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

Підтримуються два типи перевизначення:

1. Перевизначення кроків конфігурації

Ви можете перевизначити один або декілька кроків із конфігурації, передавши масив steps у запиті /begin.

Будуть перевизначені лише ті кроки, які явно вказані в запиті. Усі інші кроки конфігурації залишаються незмінними.

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

Це зазвичай використовується для:

  • Попереднього заповнення відповідей опитувальника (наприклад, ім'я, згода)

  • Динамічного коригування вмісту кроку

  • Введення даних, специфічних для користувача, у попередньо визначені потоки

Якщо надано і config_id, і steps, конфігурація використовується як основа, і перевизначаються лише відповідні кроки.

Приклад:

2. Перевизначення параметрів конфігурації (загальні)

Ви можете перевизначити параметри рівня конфігурації, передавши їх через об'єкт general у запиті /begin.

Будь-який параметр, наданий у general, перевизначить відповідне значення з конфігурації лише для цієї сесії. Параметри, які не надані, повернуться до значень конфігурації за замовчуванням.

Приклади параметрів, які можна перевизначити, включають: (Див. Налаштування конфігурації для повного списку та детальних описів усіх доступних параметрів)

{
  "language": "en",                                //Мова за замовчуванням
  "returnUrl": "https://www.identomat.com/",       //Return URL
  "optionalContinueOnAnotherDevice": false,        //Дозволити користувачу продовжити на іншому пристрої
  "restrictUrlSharing": false,                     //Обмежити поширення URL
  "switchDeviceUrl": "https://www.identomat.com/", //Передати користувацький QR URL 
  "skipDesktop": false,                            //Примусово перевести користувача на мобільний пристрій
  "useSmsNotifications": false,                    //Увімкнути SMS-сповіщення 
  "sessionLifetime": "15",                         //Тривалість сесії (хвилини)
  "identifyPersonWithFace": false,                 //Повторне розпізнавання обличчя 
  "checkScreening": true,                          //Скринінг 
  "minScreeningScore": "85",                       //Мінімальний бал скринінгу
  "screeningDatasets": ["default"],                //Набори даних для скринінгу
  "runScreeningAfter": "completion",               //Коли запускати скринінг
  "groups": ["667eb394d3ae73e1902da6dd"],          //Групи з доступом
  "requiredHdMedia": false                         //Вимагати FHD-камеру
}

Приклад запиту з використанням перевизначення параметрів:

{
  "company_key": "your-company-secret-key",
  "config_id": "62412c096c4b39ba845d4bf2",
  "general": {
    "language": "ka",
    "useSmsNotifications": true,
    "sessionLifetime": "20"
  }
}

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

begin/ - Створення сесії (нове, з підтримкою запиту додаткової інформації)

URL:

https://external-api.identomat.com/begin

Опис:

Створює нову сесію верифікації за допомогою External API. На відміну від застарілого ендпоінту, цей ендпоінт використовує назви параметрів у форматі camelCase та підтримує конфігурації з увімкненим Запитом додаткової інформації.

Коли викликається з конфігурацією, у якої additionalInformationRequest встановлено як true, ендпоінт автоматично створює батьківську сесію (для оператора) та дочірню сесію (для заявника), повертаючи обидві у відповіді.

Для нових інтеграцій цей ендпоінт рекомендовано замість застарілого ендпоінту begin/.

Параметри:

  • companyKey (string, обов'язковий) – Секретний ключ компанії.

  • configId (string, необов'язковий) – Унікальний ідентифікатор конфігурації сесії.

  • parentSessionId (string, необов'язковий) – Вказує ID батьківської сесії при створенні дочірньої сесії для верифікації з декількома учасниками.

  • name (string, необов'язковий) – Користувацька назва сесії.

  • scheduleStartTime (string, необов'язковий, ISO 8601) – Запланований час початку сесії.

  • scheduleEndTime (string, необов'язковий, ISO 8601) – Запланований час завершення сесії.

  • groupId (string, необов'язковий) – Призначає сесію конкретній групі.

  • createdByUser (string, необов'язковий) – ID користувача, що створює сесію.

  • clientUserId (string, необов'язковий) – Користувацький ідентифікатор заявника з вашого боку, корисний для зв'язування сесій із вашими внутрішніми записами користувачів.

  • general (object, необов'язковий) – Перевизначає параметри рівня конфігурації лише для цієї сесії. Див. Налаштування конфігурації для повного списку доступних параметрів.

  • flags (object, необов'язковий) – Об'єкт JSON, що містить опції налаштування сесії.

  • steps (array, необов'язковий) – Визначає або перевизначає послідовність кроків у потоці верифікації. Якщо використовується разом із configId, перевизначаються лише відповідні кроки.

Перегляньте всі приклади кроків у Посібнику для розробників.

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

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

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

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

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

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

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

Приклад cURL:

curl -X POST https://external-api.identomat.com/begin \
    -H 'Content-Type: application/json' \
    -d '{
        "companyKey": "your-company-secret-key",
        "configId": "62412c096c4b39ba845d4bf2"
    }'

Приклади параметрів запиту:

Створити стандартну сесію:

{
  "companyKey": "your-company-secret-key",
  "configId": "62412c096c4b39ba845d4bf2"
}

Створити сесію з запитом додаткової інформації:

{
  "companyKey": "your-company-secret-key",
  "configId": "62412c096c4b39ba845d4bf2"
}

Запросити додаткову інформацію для наявної сесії:

{
  "companyKey": "your-company-secret-key",
  "configId": "62412c096c4b39ba845d4bf2",
  "sessionId": "parent-session-id"
}

Коли надано sessionId, батьківська сесія залишається незмінною. Створюється лише нова дочірня сесія зі свіжим URL для заявника. Завжди діліться найновішим additionalSessionUrl із заявником.

Приклади результату:

Стандартна конфігурація:

{
  "id": "session-id",
  "url": "https://widget.identomat.com/?session_token=session-id"
}

Конфігурація з увімкненим additionalInformationRequest:

{
  "id": "parent-session-id",
  "url": "https://widget.identomat.com/?session_token=child-session-id",
  "additionalSessionId": "child-session-id",
  "additionalSessionUrl": "https://widget.identomat.com/?session_token=child-session-id"
}

Поля відповіді:

Поле
Опис

id

ID батьківської сесії. Використовуйте це, щоб відстежувати сесію в Manage та отримувати колбеки.

url

URL для заявника дочірньої сесії. Дублює additionalSessionUrl для зворотної сумісності.

additionalSessionId

ID дочірньої сесії. Присутнє лише коли `additionalInformationRequest` увімкнено в конфігурації.

additionalSessionUrl

URL для заявника дочірньої сесії. Присутнє лише коли `additionalInformationRequest` увімкнено в конфігурації.

result/ - Результат сесії KYC (клієнта)

URL:

https://widget.identomat.com/external-api/result/

Опис:

Цей ендпоінт дозволяє отримати результат сесії верифікації. На основі ID сесії, відповідь поверне остаточне рішення (approved/rejected), дані документа, витягнуту інформацію та метадані.

Параметри:

  • company_key (string, обов'язковий) - Секретний ключ компанії.

  • session_token (string, обов'язковий) - Унікальний ідентифікатор сесії.

Приклад cURL:

 curl https://widget.identomat.com/external-api/result/ \
    -F 'company_key={your-company-secret-key}' \
    -F 'session_token={example-session-id-12345}'

Приклади параметрів запиту:

{
  "company_key": "your-company-secret-key",
  "session_token": "example-session-id-12345"
}

📹 videoCallStatus:

Якщо сесія включала крок відеодзвінка, ендпоінт /result включатиме масив videoCallStatus. Це дозволяє клієнтам відстежувати життєвий цикл кожної кімнати відеодзвінка — коли її було створено, коли вона завершилась, і коли складене відеофайл стає доступним.

Приклад:

"videoCallStatus": [
  {
    "roomId": "RM27b1b047ccc30c0519959d66b4f0689d",
    "roomStatus": "ended",
    "compositionStatus": "available",
    "videoFileStatus": "available",
    "videoFileId": "hlwXVfonxNogXujgqT9anl1EphgwNiXuy7ug96sH"
  }
]

Структура об'єкта:

Кожен запис у videoCallStatus дотримується такої схеми:

{
  "roomId": "string",
  "roomStatus": "created | ended | empty",
  "compositionStatus": "null | started | available",
  "videoFileStatus": "null | started | available",
  "videoFileId": "null | string"
}

Опис статусів:

Поле
Можливі значення
Значення

roomStatus

created

Кімнату успішно створено; дзвінок триває.

ended

Оператор завершив дзвінок.

empty

Кімната відеодзвінка завершилась без запису медіа.

compositionStatus

null

Композицію ще не розпочато.

started

Композицію (об'єднання відео) розпочато.

available

Складене повне відео готове.

videoFileStatus

null

Фінальний відеофайл ще не згенеровано.

started

Генерацію відеофайлу розпочато.

available

Фінальний завантажуваний відеофайл готовий.

videoFileId

null або ID файлу

Якщо доступно, цей ID можна використати для завантаження складеного відео.

Приклади результату:

sessionApproved:

sessionRejected:

sessionNotFound:

{
  "argumentError": "session-not-found"
}
result/ - Результат сесії KYB (бізнесу)

URL:

https://external-api.identomat.com/result

Опис:

Використовуйте цей ендпоінт, щоб отримати результат сесії KYB (верифікації бізнесу).

Цей ендпоінт використовує новішу базову URL external-api.identomat.com та назви параметрів у форматі camelCase, на відміну від застарілого ендпоінту KYC.

Параметри:

  • companyKey (string, обов'язковий) - Секретний ключ компанії.

  • sessionId (string, обов'язковий) - Унікальний ідентифікатор сесії.

Приклад cURL:

Приклади параметрів запиту:

Структура відповіді

Результати KYB повертаються в масиві result.stepsResults. Кожен запис відповідає кроку в потоці KYB.

Тип кроку
Опис

company

Інформація про компанію, надана в потоці.

beneficiaries

Список UBO та представників (фізичних осіб чи компаній). Кожен окремий бенефіціар включає `sessionId` KYC, який можна отримати через ендпоінт KYC.

kyb-review

Фінальний статус перегляду та дані з довірених баз даних.

Приклад результату:

за замовчуванням:

sessionNotFound:

delete/ - Видалення даних сесії

URL:

https://widget.identomat.com/external-api/delete/

Опис:

Цей ендпоінт дозволяє остаточно видалити дані, пов'язані з конкретною сесією верифікації. Ця операція незворотна, і її слід використовувати з обережністю. Зазвичай використовується для дотримання політик зберігання даних або запитів на видалення даних користувача.

Параметри:

  • companyKey (string, обов'язковий) - Секретний ключ компанії.

  • sessionId (string, обов'язковий) - Унікальний ідентифікатор сесії.

Приклад cURL:

Приклади параметрів запиту:

Приклади результату:

за замовчуванням:

sessionNotFound:

export-session-as-pdf - Експорт сесії

URL:

https://external-api.identomat.com/export-session-as-pdf

Опис:

Цей ендпоінт дозволяє експортувати дані, пов'язані з конкретною сесією, у вигляді завантажуваного PDF-документа. Ви можете вибрати включення повних деталей сесії, результатів скринінгу та/або документів підтвердження адреси. Принаймні одна опція експорту має бути встановлена як true.

Параметри:

  • companyKey (string, обов'язковий) - Секретний ключ компанії.

  • sessionId (string, обов'язковий) - Унікальний ідентифікатор сесії.

Один із наведених нижче параметрів має бути встановлений як true, щоб операція виконалась:

  • exportSession (boolean, необов'язковий) – Вказує, чи потрібно експортувати повні дані сесії.

  • exportScreening (boolean, необов'язковий) – Визначає, чи включати результати скринінгу в експорт.

  • exportProofOfAddress (boolean, необов'язковий) - Визначає, чи включати документи підтвердження адреси в експорт.

Приклад cURL:

Приклади параметрів запиту:

Приклади результату:

за замовчуванням:

wrongParameters:

invalidAccess:

sessionNotFound:

Доступ до даних та інше

Використовуйте ці ендпоінти для отримання медіа та метаданих, пов'язаних із сесією верифікації. Це включає зображення документів, знімки обличчя, відео перевірки живості, документи підтвердження адреси, журнали активності сесії, статистичні зведення та візуальні маркери документів.

result/card-front/ - Зображення лицьової сторони картки

URL:

https://widget.identomat.com/external-api/result/card-front/

Опис:

Цей ендпоінт повертає зображення лицьової сторони документа, що посвідчує особу, поданого під час сесії.

Параметри:

  • company_key (string, обов'язковий) - Секретний ключ компанії.

  • session_token (string, обов'язковий) - Унікальний ідентифікатор сесії.

Приклад cURL:

Приклади результату:

за замовчуванням:

sessionNotFound:

result/card-back/ - Зображення зворотної сторони картки

URL:

https://widget.identomat.com/external-api/result/card-back/

Опис:

Цей ендпоінт повертає зображення зворотної сторони документа, що посвідчує особу, поданого під час сесії.

Параметри:

  • company_key (string, обов'язковий) - Секретний ключ компанії.

  • session_token (string, обов'язковий) - Унікальний ідентифікатор сесії.

Приклад cURL:

Приклади результату:

за замовчуванням:

sessionNotFound:

result/passport/ - Зображення сторінки з фото паспорта

URL:

https://widget.identomat.com/external-api/result/passport/

Опис:

Цей ендпоінт повертає зображення паспорта, поданого під час сесії.

Параметри:

  • company_key (string, обов'язковий) - Секретний ключ компанії.

  • session_token (string, обов'язковий) - Унікальний ідентифікатор сесії.

Приклад cURL:

Приклади результату:

за замовчуванням:

sessionNotFound:

result/face/ - Зображення обличчя

URL:

https://widget.identomat.com/external-api/result/face/

Опис:

Цей ендпоінт повертає зображення обличчя користувача, знятого під час сесії верифікації.

Параметри:

  • company_key (string, обов'язковий) - Секретний ключ компанії.

  • session_token (string, обов'язковий) - Унікальний ідентифікатор сесії.

Приклад cURL:

Приклади результату:

за замовчуванням:

sessionNotFound:

result/face-video/ - Відео руху обличчя

URL:

https://widget.identomat.com/external-api/result/face-video/

Опис:

Цей ендпоінт повертає відео, використане під час перевірки живості в процесі верифікації особи.

Параметри:

  • company_key (string, обов'язковий) - Секретний ключ компанії.

  • session_token (string, обов'язковий) - Унікальний ідентифікатор сесії.

Приклад cURL:

Приклади результату:

за замовчуванням:

sessionNotFound:

result/face-document/ - Селфі з ID

URL:

https://widget.identomat.com/external-api/result/face-document/

Опис:

Цей ендпоінт надає зображення, на якому користувач тримає свій документ, що посвідчує особу, поруч зі своїм обличчям.

Параметри:

  • company_key (string, обов'язковий) - Секретний ключ компанії.

  • session_token (string, обов'язковий) - Унікальний ідентифікатор сесії.

Приклад cURL:

Приклади результату:

за замовчуванням:

sessionNotFound:

result/general-document/ - Зображення чи PDF підтвердження адреси

URL:

https://widget.identomat.com/external-api/result/general-document/

Опис:

Цей ендпоінт повертає документ підтвердження адреси чи інші загальні документи, подані під час сесії, такі як банківська виписка, рахунок за комунальні послуги чи водійське посвідчення.

Параметри:

  • company_key (string, обов'язковий) - Секретний ключ компанії.

  • session_token (string, обов'язковий) - Унікальний ідентифікатор сесії.

  • typeId (string, обов'язковий) – Ідентифікатор типу документа. Допустимі значення включають:

    • bank-statement

    • utility-bill

    • vehicle-registration-certificate-front

    • vehicle-registration-certificate-back

    • drivers-license

Приклад cURL:

Приклади параметрів запиту:

Приклади результату:

за замовчуванням:

sessionNotFound:

get-session-main-document-face-photo - Отримати фото обличчя з основного документа

URL:

https://external-api.identomat.com/get-session-main-document-face-photo

Опис:

Цей ендпоінт дозволяє отримати фото обличчя з основного документа, пов'язаного з конкретною сесією.

Параметри:

  • companyKey (string, обов'язковий) - Секретний ключ компанії.

  • sessionId (string, обов'язковий) - Унікальний ідентифікатор сесії.

Приклад cURL:

Приклади параметрів запиту:

Приклади результату:

за замовчуванням:

invalidAccess:

notFound:

sessionNotFound:

list-session-activities - Список активностей сесії

URL:

https://external-api.identomat.com/list-session-activities

Опис:

Цей ендпоінт отримує список активностей, пов'язаних із конкретною сесією.

Параметри:

  • companyKey (string, обов'язковий) - Секретний ключ компанії.

  • sessionId (string, обов'язковий) - Унікальний ідентифікатор сесії.

Приклад cURL:

Приклади параметрів запиту:

Приклади результату:

за замовчуванням:

invalidAccess:

sessionNotFound:

get-session-statistical-summary - Статистичне зведення сесії

URL:

https://external-api.identomat.com/get-session-statistical-summary

Опис:

Цей ендпоінт отримує статистичне зведення сесії, надаючи ключові метрики та відомості.

Параметри:

  • companyKey (string, обов'язковий) - Секретний ключ компанії.

  • sessionId (string, обов'язковий) - Унікальний ідентифікатор сесії.

Приклад cURL:

Приклади параметрів запиту:

Приклади результату:

за замовчуванням:

invalidAccess:

sessionNotFound:

get-visual-markers - Отримати візуальні маркери документа

URL:

https://external-api.identomat.com/get-visual-markers

Опис:

Цей ендпоінт отримує візуальні маркери з документа.

Параметри:

  • companyKey (string, обов'язковий) - Секретний ключ компанії.

  • sessionId (string, обов'язковий) - Унікальний ідентифікатор сесії.

Приклад cURL:

Приклади параметрів запиту:

Приклади результату:

за замовчуванням:

wrongParameters:

invalidAccess:

sessionNotFound:

AML-скринінг

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

search-screening-person - Пошук особи в базах даних скринінгу

URL:

https://external-api.identomat.com/search-screening-person

Опис:

Використовуйте цей ендпоінт для пошуку осіб у глобальних базах даних скринінгу, включно з санкціями, PEP (публічно значущими особами), регуляторними діями та іншим.

Параметри:

  • companyKey (string, обов'язковий) - Секретний ключ компанії.

  • query (object, обов'язковий) – Параметри для запиту до бази даних.

    • fullName (string, обов'язковий) – Повне ім'я особи.

    • birthdayTimeFrom (string, необов'язковий) – Початкова дата та час діапазону дня народження у форматі ISO 8601.

    • scoreThreshold (integer, обов'язковий) – Мінімальний бал, необхідний для результатів запиту.

  • offset (integer, необов'язковий) – Кількість елементів, які потрібно пропустити з початку результатів.

  • limit (integer, необов'язковий) – Максимальна кількість елементів для повернення в результатах запиту.

Глосарій об'єктів:

  • Sanctioned entity (Санкціонований об'єкт): Компанії, фізичні особи чи інші об'єкти, які уряд визначив для заборони конкретних взаємодій із ними.

  • Sanction-linked entity (Об'єкт, пов'язаний із санкціями): Об'єкти, включно з компаніями та фізичними особами, які мають пряме відношення до санкціонованого об'єкта. Це також включає компанії, які є непрямими дочірніми підприємствами санкціонованих об'єктів, незалежно від відсотка володіння санкціонованого об'єкта.

  • Counter-sanctioned entity (Контрсанкціонований об'єкт): Об'єкти, внесені до санкційних списків недемократичних країн, часто спрямовані проти продемократичних активістів, журналістів та правозахисників.

  • Debarred entity (Виключений об'єкт): Компанії чи фізичні особи, виключені з державних закупівель, зазвичай через шахрайство при виконанні державного контракту.

  • Politician (Politically Exposed Persons) (Політик — публічно значуща особа): Особи, які нині чи раніше обіймали посаду з політичним впливом.

  • Close associate (Близький партнер): Члени сім'ї та ключові ділові партнери публічно значущих осіб (PEP). Ці особи часто використовуються як номінальні особи чи прикриття для приховування незаконних фінансових доходів.

  • Person of Interest (Особа інтересу): Особи, під підвищеною увагою через суспільний інтерес, які не відповідають загальним визначенням публічно значущих осіб і не є санкціонованими.

  • Regulator action (Регуляторна дія): Компанії, до яких застосовано примусові заходи з боку галузевого регуляторного органу.

  • Regulator warning (Регуляторне попередження): Компанії, внесені до списку попереджень чи сповіщень галузевим регуляторним органом.

Приклад cURL:

Приклади параметрів запиту:

Приклади результату:

за замовчуванням - немає результатів для особи:

за замовчуванням - особу знайдено:

companyMissing:

accessDenied:

get-screening-person-details - Отримати деталі особи з баз даних скринінгу

URL:

https://external-api.identomat.com/get-screening-person-details

Опис:

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

Параметри:

  • companyKey (string, обов'язковий) - Секретний ключ компанії.

  • personId (string, обов'язковий) – Унікальний ідентифікатор особи.

Приклад cURL:

Приклади параметрів запиту:

Приклади результату:

за замовчуванням:

companyMissing:

accessDenied:

monitor-screening-query - Встановити особу на моніторинг

URL:

https://external-api.identomat.com/monitor-screening-query

Опис:

Увімкнути постійний моніторинг конкретної особи в базах даних скринінгу. Якщо особа вже на моніторингу, буде повернуто відповідну помилку.

Параметри:

  • companyKey (string, обов'язковий) - Секретний ключ компанії.

  • query (object, обов'язковий) – Параметри для запиту до бази даних.

    • fullName (string, обов'язковий) – Прізвище особи.

    • birthdayTimeFrom (string, необов'язковий) – Початкова дата та час діапазону дня народження у форматі ISO 8601.

Приклад cURL:

Приклади параметрів запиту:

Приклади результату:

за замовчуванням:

Уже на моніторингу:

remove-screening-query-from-monitoring - Видалити особу з моніторингу

URL:

https://external-api.identomat.com/remove-screening-query-from-monitoring

Опис:

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

Параметри:

  • companyKey (string, обов'язковий) - Секретний ключ компанії.

  • id (string, обов'язковий) - ID запиту моніторингу.

Приклад cURL:

Приклади параметрів запиту:

Приклади результату:

за замовчуванням:

list-screening-monitoring-records - Список записів скринінгу, що моніторяться

URL:

https://external-api.identomat.com/list-screening-monitoring-records

Опис:

Отримує список осіб, які наразі перебувають під моніторингом скринінгу. Це включає базові метадані, такі як ім'я, ID та, опційно, дату останнього оновлення.

Параметри:

  • companyKey (string, обов'язковий) - Секретний ключ компанії.

  • start (integer, необов'язковий) – Кількість елементів, які потрібно пропустити з початку результатів.

  • limit (integer, необов'язковий) – Максимальна кількість записів для повернення.

  • date (string, необов'язковий, формат ISO 8601) – Фільтрує записи після конкретної дати. Якщо дату не вказано, буде повернено весь список.

Приклад cURL:

Приклади параметрів запиту:

Приклади результату:

за замовчуванням:

Керування чорним списком

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

add-blacklist-record - Додати особу до чорного списку

URL:

https://external-api.identomat.com/add-blacklist-record

Опис:

Додає особу до чорного списку на основі ідентифікаційних атрибутів, таких як ім'я, номер документа чи особистий номер.

Параметри:

  • companyKey (string, обов'язковий) - Секретний ключ компанії.

  • query (object of strings, обов'язковий) - Об'єкт, що містить деталі запиту. Має включати reason та принаймні одне з наступного: firstName, lastName, personalNumber, documentNumber, birthday.

    • firstName (string, необов'язковий) - Ім'я особи.

    • lastName (string, необов'язковий) - Прізвище особи.

    • personalNumber (string, необов'язковий) - Особистий ідентифікаційний номер.

    • documentNumber (string, необов'язковий) - Номер документа (наприклад, з ID чи паспорта).

    • birthday (string, необов'язковий) - Дата народження у форматі ISO 8601 (наприклад, 1990-05-14).

    • reason (string, обов'язковий) - Причина внесення особи до чорного списку.

Приклад cURL:

Приклади параметрів запиту:

Приклади результату:

за замовчуванням:

wrongParameters:

invalidCompanyKey:

alreadyExists

remove-blacklist-record - Видалити запис із чорного списку

URL:

https://external-api.identomat.com/remove-blacklist-record

Опис:

Видаляє раніше доданий запис із чорного списку.

Параметри:

  • companyKey (string, обов'язковий) - Секретний ключ компанії.

  • id (string, обов'язковий) - ID запису чорного списку.

Приклад cURL:

Приклади параметрів запиту:

Приклади результату:

за замовчуванням:

wrongParameters:

invalidCompanyKey:

idNotFound:

list-blacklist-records - Список усіх записів чорного списку компанії

URL:

https://external-api.identomat.com/list-blacklist-records

Опис:

Отримує всі записи чорного списку, пов'язані з компанією. Ви можете за бажанням фільтрувати записи за запитом, встановити пагінацію за допомогою offset та limit, або отримати повний список.

Параметри:

  • companyKey (string, обов'язковий) - Секретний ключ компанії.

  • query (object of strings, необов'язковий) - Необов'язкові поля фільтра:

    • offset (number, необов'язковий) - Кількість записів, які потрібно пропустити з початку.

    • limit (number, необов'язковий) - Максимальна кількість записів для повернення.

Приклад cURL:

Приклади параметрів запиту:

Приклади результату:

за замовчуванням:

wrongParameters:

invalidCompanyKey:

noRecord:

Відеодзвінок

Використовуйте ці ендпоінти для керування та отримання даних із сесій відеодзвінків. Ви можете отримати доступ до знімків екрана, зроблених оператором під час дзвінка, отримати записані відеофайли та програмно завершити активний дзвінок.

get-video-call-shots - Знімки відеодзвінка

URL:

https://external-api.identomat.com/get-video-call-shots

Опис:

Отримує всі знімки екрана (shots), зроблені оператором під час сесії відеодзвінка. Ці зображення слугують частиною доказів, зібраних під час верифікації KYC.

Параметри:

  • companyKey (string, обов'язковий) - Секретний ключ компанії.

  • sessionId (string, обов'язковий) - Унікальний ідентифікатор сесії.

Приклад cURL:

Приклади параметрів запиту:

Приклади результату:

за замовчуванням:

invalidAccess:

sessionNotFound:

get-video-call-videos - Відео відеодзвінка

URL:

https://external-api.identomat.com/get-video-call-videos

Опис:

Отримує відеозаписи з сесії відеодзвінка. Ендпоінт підтримує два режими отримання:

  1. Пріоритетний (рекомендовано): отримати один відеофайл за допомогою параметра fileId.

  2. Застарілий: отримати всі відеофайли одразу (повертається у вигляді архіву .tar).

Використання fileId рекомендовано для кращої продуктивності, зменшеного розміру payload та підвищеної надійності.

Параметри:

Обов'язкові

  • companyKey (string) — Секретний ключ компанії.

  • sessionId (string) — Унікальний ідентифікатор сесії.

Необов'язкові (рекомендовані)

  • fileId (string) — Унікальний ID відеофайлу, який ви хочете отримати. Якщо надано, ендпоінт повертає лише вказаний відеофайл замість повного архіву.

Приклад cURL:

Приклади параметрів запиту:

Приклади результату:

один файл:

всі файли:

invalidAccess:

notFound:

sessionNotFound:

end-video-call - Завершити відеодзвінок для підключеного користувача

URL:

https://external-api.identomat.com/end-video-call

Опис:

Вручну завершує активну сесію відеодзвінка для підключеного користувача. Цей ендпоінт зазвичай використовується системою для примусового закриття сесії, яка все ще триває.

Параметри:

  • companyKey (string, обов'язковий) - Секретний ключ компанії.

  • sessionId (string, обов'язковий) - Унікальний ідентифікатор сесії.

Приклад cURL:

Приклади параметрів запиту:

Приклади результату:

за замовчуванням:

invalidAccess:

Вкладення опитувальника

Використовуйте ці ендпоінти для керування файлами, пов'язаними із запитаннями типу «вкладення» у кроках опитувальника. Файли можуть надходити з декількох джерел — завантажені користувачем під час сесії KYC, подані оператором у Manage, визначені статично в конфігурації, або завантажені програмно через API.

get-question-file - Отримати файл із запитання

URL:

https://external-api.identomat.com/get-question-file

Опис:

Отримує файл, прикріплений до запитання в кроці опитувальника. Використовуйте цей ендпоінт для доступу до файлів незалежно від того, як вони були подані — це включає файли, завантажені користувачем під час сесії KYC та файли, подані оператором у Manage. Використовуйте fileIndex для посилання на конкретний файл, коли до одного запитання прикріплено декілька файлів.

Параметри:

  • companyKey (string, обов'язковий) - Секретний ключ компанії.

  • sessionId (string, обов'язковий) - Унікальний ідентифікатор сесії.

  • stepKey (string, обов'язковий) – Унікальний ключ кроку опитувальника.

  • questionKey(string, обов'язковий) – Унікальний ключ запитання в межах опитувальника.

  • fileIndex (integer, необов'язковий) – Індекс файлу, коли до запитання завантажено декілька файлів. Використовується для посилання на конкретний файл у межах вкладень запитання.

Приклад cURL:

Приклади параметрів запиту:

Приклади результату:

за замовчуванням:

wrongParameters:

invalidAccess:

sessionNotFound:

upload-file - Завантажити файл до запитання

URL:

https://external-api.identomat.com/upload-file

Опис:

Завантажує файл до конкретного запитання типу «вкладення» в межах кроку опитувальника. Файл має бути наданий у вигляді data URI, закодованого у base64. Повертає fileId, який можна використати для отримання чи видалення файлу пізніше.

Підтримувані формати:

  • data:application/pdf;base64,...

  • data:image/jpeg;base64,...

  • data:image/png;base64,...

Параметри:

  • companyKey (string, обов'язковий) — Секретний ключ компанії.

  • sessionId (string, обов'язковий) — Унікальний ідентифікатор сесії.

  • stepKey (string, обов'язковий) — Унікальний ключ кроку опитувальника.

  • questionKey (string, обов'язковий) — Унікальний ключ запитання типу «вкладення».

  • content (string, обов'язковий) — Вміст файлу у вигляді data URI, закодованого у base64 (наприклад, data:image/png;base64,...).

Приклад cURL:

Приклад параметрів запиту:

Приклади результату:

за замовчуванням:

sessionNotFound:

invalidAccess:

wrongParameters:

get-file - Отримати файл із запитання

URL:

https://external-api.identomat.com/get-file

Опис:

Отримує файл, який був програмно завантажений через ендпоінт upload-file.

Параметри:

  • companyKey (string, обов'язковий) — Секретний ключ компанії.

  • sessionId (string, обов'язковий) — Унікальний ідентифікатор сесії.

  • stepKey (string, обов'язковий) — Унікальний ключ кроку опитувальника.

  • questionKey (string, обов'язковий) — Унікальний ключ запитання типу «вкладення».

  • filename (string, обов'язковий) — ID файлу, повернутий upload-file.

Приклад cURL:

Приклад параметрів запиту:

Приклади результату:

за замовчуванням:

sessionNotFound:

invalidAccess:

wrongParameters:

delete-file - Видалити файл із запитання

URL:

https://external-api.identomat.com/delete-file

Опис:

Остаточно видаляє раніше завантажений файл із запитання типу «вкладення». Ця операція незворотна.

Параметри:

  • companyKey (string, обов'язковий) — Секретний ключ компанії.

  • sessionId (string, обов'язковий) — Унікальний ідентифікатор сесії.

  • stepKey (string, обов'язковий) — Унікальний ключ кроку опитувальника.

  • questionKey (string, обов'язковий) — Унікальний ключ запитання типу «вкладення».

  • filename (string, обов'язковий) — ID файлу, повернутий upload-file.

Приклад cURL:

Приклад параметрів запиту:

Приклади результату:

за замовчуванням:

sessionNotFound:

invalidAccess:

wrongParameters:

Інші методи

Використовуйте ці ендпоінти для керування групами, користувачами та конфігураціями сесій у Manage. Групи можна використовувати для контролю того, які оператори мають доступ до конкретних сесій. Ендпоінти керування користувачами дозволяють програмно створювати, переглядати список та видаляти користувачів платформи. Ви також можете отримати повні деталі конфігурації сесії за її ID.

list-groups - Список груп

URL:

https://external-api.identomat.com/list-groups

Опис:

Отримує список груп, пов'язаних із зазначеною компанією. Кожна група включає свій ID, назву, опис та список учасників.

Параметри:

  • companyKey (string, обов'язковий) - Секретний ключ компанії.

Приклад cURL:

Приклади параметрів запиту:

Приклади результату:

за замовчуванням:

noGroups:

notFound:

make-group - Створити нову групу

URL:

https://external-api.identomat.com/make-group

Опис:

Створює нову групу користувачів у межах зазначеної компанії. Групу можна використати для керування правами доступу, призначення сесій чи організації користувачів.

Параметри:

  • companyKey (string, обов'язковий) - Секретний ключ компанії.

  • name (string, обов'язковий) – Назва нової групи.

  • description (string, необов'язковий) - Опис нової групи.

  • memberIds (array of strings, необов'язковий) – Список ID користувачів для додавання до групи.

Приклад cURL:

Приклади параметрів запиту:

Приклади результату:

за замовчуванням:

wrongParameter:

change-group - Оновити наявну групу

URL:

https://external-api.identomat.com/make-group

Опис:

Дозволяє змінити наявну групу, оновивши її назву чи змінивши учасників групи. Щоб зберегти наявних учасників у групі, ви маєте включити їхні ID до списку.

Параметри:

  • companyKey (string, обов'язковий) - Секретний ключ компанії.

  • groupId (string, обов'язковий) – Унікальний ідентифікатор групи.

  • name (string, необов'язковий) – Назва нової групи.

  • description (string, необов'язковий) - Опис нової групи.

  • memberIds (array of strings, необов'язковий) – Список ID користувачів для додавання чи видалення з групи. Щоб зберегти наявних учасників у групі, ви маєте включити їхні ID до списку.

Приклад cURL:

Приклади параметрів запиту:

Приклади результату:

за замовчуванням:

wrongParameter:

delete-group - Видалити групу

URL:

https://external-api.identomat.com/delete-group

Опис:

Дозволяє остаточно видалити групу із системи.

Параметри:

  • companyKey (string, обов'язковий) - Секретний ключ компанії.

  • groupId (string, обов'язковий) – Унікальний ідентифікатор групи.

Приклад cURL:

Приклади параметрів запиту:

Приклади результату:

за замовчуванням:

wrongParameter:

list-users - Список користувачів

URL:

https://external-api.identomat.com/list-users

Опис:

Цей ендпоінт отримує список користувачів, пов'язаних із компанією.

Параметри:

  • companyKey (string, обов'язковий) - Секретний ключ компанії.

Приклад cURL:

Приклади параметрів запиту:

Приклади результату:

за замовчуванням:

wrongParameters:

invalidAccess:

create-user - Створити користувача

URL:

https://external-api.identomat.com/create-user

Опис:

Створює нового користувача для платформи Identomat (Manage).

Параметри:

  • companyKey (string, обов'язковий) - Секретний ключ компанії.

  • email (string, обов'язковий) - Адреса електронної пошти нового користувача.

  • emailVerified (boolean, необов'язковий) - Чи слід позначати email як підтверджений. За замовчуванням false.

  • password (string, обов'язковий) - Пароль користувача (мінімум 8 символів).

  • firstName (string, необов'язковий) - Ім'я користувача.

  • lastName (string, необов'язковий) - Прізвище користувача.

  • rights (array of strings, необов'язковий) - Список ролей для призначення користувачеві. Якщо не вказано, за замовчуванням call_center_operator. Допустимі значення:

    • call_center_operator

    • operator

    • administrator

Приклад cURL:

Приклади параметрів запиту:

Приклади результату:

за замовчуванням:

wrongParameters:

invalidCompanyKey:

invalidEmailFormat:

passwordTooShort

passwordIsNotString

invalidRights

userAlreadyExists:

delete-user - Видалити користувача

URL:

https://external-api.identomat.com/delete-user

Опис:

Видаляє користувача з платформи Identomat (Manage).

Параметри:

  • companyKey (string, обов'язковий) - Секретний ключ компанії.

  • userId (string, обов'язковий) - Унікальний ідентифікатор користувача.

Приклад cURL:

Приклади параметрів запиту:

Приклади результату:

за замовчуванням:

wrongParameters:

invalidCompanyKey:

userNotFound:

get-session-config - Отримати конфігурацію сесії

URL:

https://external-api.identomat.com/get-session-config

Опис:

Цей ендпоінт отримує деталі конфігурації для конкретної конфігурації сесії на основі наданого ID конфігурації сесії.

Параметри:

  • companyKey (string, обов'язковий) - Секретний ключ компанії.

  • sessionConfigId (string, обов'язковий) – Унікальний ідентифікатор конфігурації сесії.

Приклад cURL:

Приклади параметрів запиту:

Приклади результату:

за замовчуванням:

wrongParameters:

Обробка зображення

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

card/front/ - Лицьова сторона ID-картки

URL:

https://widget.identomat.com/external-api/card/front/

Параметри:

  • company_key (string, обов'язковий) - Секретний ключ компанії.

  • image (file, обов'язковий) – Файл зображення JPEG для завантаження.

Приклад cURL:

Приклади результату:

за замовчуванням:

card/back/ - Зворотна сторона ID-картки

URL:

https://widget.identomat.com/external-api/card/back/

Параметри:

  • company_key (string, обов'язковий) - Секретний ключ компанії.

  • image (file, обов'язковий) – Файл зображення JPEG для завантаження.

Приклад cURL:

Приклади результату:

за замовчуванням:

license/front/ - Лицьова сторона водійського посвідчення

URL:

https://widget.identomat.com/external-api/license/front/

Параметри:

  • company_key (string, обов'язковий) - Секретний ключ компанії.

  • image (file, обов'язковий) – Файл зображення JPEG для завантаження.

Приклад cURL:

Приклади результату:

за замовчуванням:

license/back/ - Зворотна сторона водійського посвідчення

URL:

https://widget.identomat.com/external-api/license/back/

Параметри:

  • company_key (string, обов'язковий) - Секретний ключ компанії.

  • image (file, обов'язковий) – Файл зображення JPEG для завантаження.

Приклад cURL:

Приклади результату:

за замовчуванням:

residence/front/ - Лицьова сторона посвідки на проживання

URL:

https://widget.identomat.com/external-api/residence/front/

Параметри:

  • company_key (string, обов'язковий) - Секретний ключ компанії.

  • image (file, обов'язковий) – Файл зображення JPEG для завантаження.

Приклад cURL:

Приклади результату:

за замовчуванням:

residence/back/ - Зворотна сторона посвідки на проживання

URL:

https://widget.identomat.com/external-api/residence/back/

Параметри:

  • company_key (string, обов'язковий) - Секретний ключ компанії.

  • image (file, обов'язковий) – Файл зображення JPEG для завантаження.

Приклад cURL:

Приклади результату:

за замовчуванням:

passport/ - Сторінка з фото паспорта

URL:

https://widget.identomat.com/external-api/passport/

Параметри:

  • company_key (string, обов'язковий) - Секретний ключ компанії.

  • image (file, обов'язковий) – Файл зображення JPEG для завантаження.

Приклад cURL:

Приклад результату:

за замовчуванням:

Додаткова обробка

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

compare-faces/ - Отримати бал схожості для двох облич

Мінімальний рекомендований розмір обличчя на зображенні — 80 пікселів. Якщо розмір обличчя становить 65-79 пікселів, буде повернуто код помилки разом із балом схожості.

URL:

https://external-api.identomat.com/compare-faces

Параметри:

  • companyKey (string, обов'язковий) - Секретний ключ компанії.

  • face1 (file, обов'язковий) - Файл зображення JPEG для обличчя1

  • face2 (file, обов'язковий) - Файл зображення JPEG для обличчя2

Приклад cURL:

Приклади результату:

за замовчуванням:

error:

PreviousKYB (Know Your Business)
NextКолбеки

Last updated

Was this helpful?