Skip to content
Overview Integration flow Web SDK Android SDK iOS SDK API Reference

Web SDK overview

The Prove ID Web SDK is a ready-made component that runs the ID document and face verification flow in the user’s browser. Camera access, automatic document capture, liveness checks and sending the results to Prove ID are all handled by the SDK; you add the component to your page and listen for the result.

The SDK ships as a custom element called <techsign-kyc>, so it works the same way in plain HTML, React, Vue, Angular and any other framework. A ready-made React component is also included.

Flow

Section titled “Flow”

The user goes through the steps below. You choose which steps appear through the configuration.

  1. Document type — the user picks their document if card-type is not set.
  2. Front side — the document is detected and captured automatically.
  3. Back side — for the Turkish ID card and foreign ID cards.
  4. Hologram — optional; for the Turkish ID card and driving licence.
  5. Face — the user is asked for a simple gesture (blink, open mouth or head movement) and liveness is verified with a short video.
  6. Result screen — optional.

When the flow ends, the component fires the complete event.

Supported documents

Section titled “Supported documents”
card-type Document
IDCARD Turkish ID Card
OLDIDCARD Old Turkish ID Card
DRIVERCARD Driving Licence
PASSPORT Passport
FOREIGNID Foreign ID Card

Requirements

Section titled “Requirements”
  • The page must be served over HTTPS (except localhost); browsers only allow camera access in a secure context.
  • The SDK is designed for mobile devices. On desktop it shows a QR code by default so the user can continue on their phone (change with allow-desktop).
  • The phone must be held upright; landscape use is blocked by default (allow-landscape).
  • Test on iOS Safari and Android Chrome before going live.