Installation
The SDK is delivered as the @techsign/kyc package. Pick the option that fits your project.
| Your project | Recommendation |
|---|---|
| Plain HTML / PHP / .NET Razor | Copy the files to your server; use techsign-kyc.js (module) or techsign-kyc.iife.js |
| React | @techsign/kyc/react |
| Vue / Angular / other | @techsign/kyc + the custom element |
| Document only, no face | Any of the above + enable-face="false" |
With npm
Section titled “With npm”npm install @techsign/kycIf the package was delivered to you as a folder or zip:
npm install ./vendor/techsign-kyc# the folder must contain package.json and dist/By copying the files to your server
Section titled “By copying the files to your server”Put the package contents under, for example, /sdk/:
/sdk/techsign-kyc.js/sdk/chunks/... ← required when using the module build/sdk/techsign-kyc.iife.js ← only when using the IIFE buildPackage contents
Section titled “Package contents”| File | When |
|---|---|
techsign-kyc.js + chunks/ |
Recommended. Modern browsers, <script type="module"> or a bundler. When the face step is off, the face code is never downloaded. |
techsign-kyc.iife.js |
Older pages and a single <script> tag. One file with the face code included, so it is larger. |
index.js + chunks/ + *.d.ts |
npm and bundlers (Vite, Webpack): import '@techsign/kyc' |
react.js + chunks/ |
React: import { TechsignKyc } from '@techsign/kyc/react' |
TypeScript types are included in the package (CompleteDetail, ErrorDetail, SdkOptions, …).