kyc-widget

v1.0.7

Published

16 days ago

Kyc Widget

Downloads

108

0High
0Medium
0Low

enface

KYC Widget

1. Пример подключения в JavaScript приложение

Определяем кнопку <button id="btn">Open KYC Widget</button> и обработчик события клика
Подключаем скрипт в теге <script src=""> </script> перед закрывающимся тегом </body>
Ниже определяем код интеграции:
- schemaId: уникальный идентификатор схемы, который необходимо получить в личном кабинете пользователя в разделе «KYC/AML» (обязательно);
- clientKey: ключ клиента это любая строка, максимальной длины 36 символов, определяемая клиентом в зависимости от его бизнес-логики (обязательно);
- theme: "light" | "dark" тема, по умолчанию "dark" (не обязательно);
- debug: true | false режим отладки, по умолчанию false (не обязательно);
- avatarName: "fox" | "none" тип аватара, по умолчанию "fox", "none" - video режим (не обязательно);

File: index.html

  <body>
    <button id="btn">Open KYC Widget</button>

    <!-- Подключение скрипта -->
    <script src="https://kyc.enface.ai/lib/widget-lib.js"></script>

    <!-- Пример запуска виджета-->
    <script>
      const btn = document.getElementById("btn");

      const openWidget = () => {
        window.KYCWidget.setupKYC({
          schemaId: "SCHEMA_ID",
          clientKey: "CLIENT_KEY",
          theme: "light",
          debug: true,
          avatarName: "none"
        });
      };

      btn.addEventListener("click", openWidget);
    </script>
  </body>

2. Пример подключения в React приложение

Установка npm package: npm i kyc-widget
Импорт в приложение: import { KycWidget } from "kyc-widget"
Определяем стейт true/false отображения виджета: const [isOpen, setIsOpen] = useState(false)
Определяем кнопку <button onClick={() => setIsOpen(true)}>Open</button> и обработчик события клика
Пропсы передаваемые в компонент виджета:
- schemaId: уникальный идентификатор схемы, который необходимо получить в личном кабинете пользователя в разделе «KYC/AML» (обязательно);
- clientKey: ключ клиента это любая строка, максимальной длины 36 символов, определяемая клиентом в зависимости от его бизнес-логики (обязательно);
- isOpen: boolean значение (обязательно);
- closeCb: callback func закрытия виджета (обязательно);
- theme: "light" / "dark" тема, по умолчанию "dark" (не обязательно);
- debug: true / false режим отладки, по умолчанию false (не обязательно);
- avatarName: "fox" / "none" тип аватара, по умолчанию "fox", "none" - video режим (не обязательно);

File: App.js

import { useState } from "react";
import { KycWidget } from "kyc-widget";

function App() {
  const [isOpen, setIsOpen] = useState(false);

  return (
    <>
      <button onClick={() => setIsOpen(true)}>Open</button>

      <KycWidget
        schemaId="SCHEMA_ID"
        clientKey="CLIENT_KEY"
        isOpen={isOpen}
        closeCb={() => setIsOpen(false)}
        theme="light"
        debug={true}
        avatarName="none"
      />

    </>
  );
}

export default App;

3. Верификация по ссылке

Для прохождения верификации возможно воспользоваться сервисом https://kyc.enface.ai

При переходе по ссылке приведенной ниже создается сессия

  https://kyc.enface.ai/schemaId/clientKey

schemaId - уникальный идентификатор схемы, который необходимо получить в личном кабинете пользователя в разделе «KYC/AML»;
clientKey - ключ клиента это любая строка, максимальной длины 36 символов, определяемая клиентом в зависимости от его бизнес-логики;

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

KYC Widget

1. Пример подключения в JavaScript приложение

2. Пример подключения в React приложение

3. Верификация по ссылке