Sessions required

Every yes:id SDK module needs a valid session before it can run. Complete the Sessions Guide first — it takes 5 minutes and is required before the code below will work.

Installing the Document Reader SDK

1. Add the Maven repositories

settings.gradle

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.PREFER_SETTINGS)
    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" }
    }
}

2. Add the dependencies

build.gradle (app)

dependencies {
    implementation("io.yesid:licensing:0.5.9")
    implementation("io.yesid:card_detection:0.5.9")
}

3. Permissions

AndroidManifest.xml

<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.INTERNET" />

The SDK requests the camera permission at runtime. You do not need to request it before showing the camera.

4. Minimum requirements

Requirement	Value
minSdk	23
compileSdk	36
Kotlin	2.0.0

Ktor version

Keep your app on Ktor 2.x. Ktor 2 and 3 are binary-incompatible on the same classpath and will silently stall all HTTP calls. See Troubleshooting.

Ready to integrate?

Dependencies are installed. Next: Usage →