Kinegram eMRTD Connector SDK Android

The Kinegram eMRTD Connector enables your Android app to read and verify electronic passports / id cards (eMRTDs).

    ┌───────────────┐     Results     ┌─────────────────┐
    │ DocVal Server │────────────────▶│   Your Server   │
    └───────────────┘                 └─────────────────┘
            ▲
            │ WebSocket
            ▼
┏━━━━━━━━━━━━━━━━━━━━━━━━┓
┃                        ┃
┃    eMRTD Connector     ┃
┃                        ┃
┗━━━━━━━━━━━━━━━━━━━━━━━━┛
            ▲
            │ NFC
            ▼
    ┌──────────────┐
    │              │
    │   PASSPORT   │
    │              │
    │   ID CARD    │
    │              │
    │              │
    │   (eMRTD)    │
    │              │
    └──────────────┘

The Kinegram eMRTD Connector enables the Document Validation Server (DocVal) to communicate with the eMRTD through a secure WebSocket connection.

Example App

This project contains an Example App to demonstrate usage and functionality.

Running

Enable adb debugging on your device and connect it with USB.

Open the project with Android Studio and click run.

Include the Kinegram eMRTD Connector in your app

Add the dependencies to your app's gradle build configuration.

Configure your app-level build.gradle (app/build.gradle) file to include the emrtdconnector dependency.
Replace <version> with the version you want to use. You can find the latest version in the releases.

Kotlin (app/build.gradle.kts)

dependencies {
	...
	implementation("com.kinegram.android:emrtdconnector:<version>")
}

Groovy (app/build.gradle)

dependencies {
	...
	implementation 'com.kinegram.android:emrtdconnector:<version>'
}

Usage and API description

Open the Dokka Documentation in your preferred browser.

There is also a JavaDoc Documentation available if you prefer the old JavaDoc style.

Changelog

Privacy Notice

ℹ️ Privacy Notice

Bastian/emrtd-connector-sdk-android