yes:id Developer Documentation

yes:id provides drop-in SDKs for identity capture, verification, and liveness detection. Integrate OCR, face biometrics, touchless fingerprint capture, and document scanning in minutes.

Document Reader SDK

Scan and OCR identity documents on Android, iOS, and Web. Camera and gallery upload, single and double-sided capture.

Face SDK

Liveness detection, face enrollment, and face matching with built-in fraud defense.

Web SDK

Browser document capture and liveness. Install @yesid/document-scanner and @yesid/liveness-sdk — web components or React.

Touchless SDK

Contactless fingerprint capture. Returns fingerprint image data and NFIQ quality scores.

Flutter

Cross-platform plugin wrapping the Android and iOS SDKs.

React Native

Native modules bridging OCR, face, and touchless capture to JavaScript.

Sessions Guide

All SDK modules are session-gated. Start here — complete this before integrating any SDK.

---

Quick start

Add the yes:id Maven repository and install the modules you need:

settings.gradle

dependencyResolutionManagement {
    repositories {
        google()
        mavenCentral()
        maven { url "https://maven.yesid.io/releases" }
        maven { url "https://maven.regulaforensics.com/RegulaDocumentReader" }
        maven { url "https://maven.regulaforensics.com/RegulaDocumentReaderWebClient" }
        maven { url "https://jitpack.io" }
    }
}

build.gradle (app)

dependencies {
    implementation("io.yesid:licensing:0.5.9")
    implementation("io.yesid:card_detection:0.5.9")
    implementation("io.yesid:face:0.5.9")
    implementation("io.yesid:touchless:0.5.9") { transitive = true }
}

Web

npm install @yesid/document-scanner @yesid/liveness-sdk

The @yesid scope is served from https://npm.yesid.tech/. See Document Capture — Installation and Liveness — Installation.

Sessions Required

Every SDK module validates a session token before processing. See the Sessions Guide.

Requirements

Android

Component	Minimum
minSdk	23
compileSdk / targetSdk	36
Kotlin	2.0.0
Android Gradle Plugin	8.10.1

Web

Component	Minimum
Node.js	16+
Secure context	HTTPS or localhost
Packages	@yesid/document-scanner 1.6.1, @yesid/liveness-sdk 1.4.6