Android SDK overview

The Prove ID Android SDK is a toolkit for running ID document capture, NFC chip reading, hologram checks and liveness verification in your Android app. You design the screens and the order of the flow; the SDK gives you ready-made camera screens (Fragments), an NFC reader and the Prove ID service calls.

Packages

Package	Contents
com.techsign:rkyc-cnn	Service client (ServerCall, Authentication, EndpointManager), liveness and hologram screens, result models
com.techsign:id-card-detection-cnn	Camera screen that detects and captures the ID document on the device
com.techsign:passport-reader-cnn	Reads the chip of ID cards and passports over NFC

Flow

A typical verification consists of the steps below. You choose which steps run when you start the transaction.

1. Start the transaction — a transaction is opened on Prove ID and you get a transaction ID (transactionId).
2. Document front — the document is detected in the camera, captured and verified.
3. Document back — for documents with a back side, such as the Turkish ID card.
4. Hologram — optional; the hologram is checked with a short video.
5. NFC — optional; the chip on the document is read and verified.
6. Liveness — the user is asked for a short gesture and their face is compared with the document photo.
7. Result — the outcome of every check is fetched with the transaction ID.

Supported documents

Document	idType	CardType
Turkish ID card	IDCARD	NEW_ID, NEW_ID_BACK
Old Turkish ID card	OLDIDCARD	OLD_ID
Driving licence	DRIVERCARD	NEW_DRIVER
Passport	PASSPORT	PASSPORT
Blue card	BLUECARD	BLUE_CARD
Foreign ID card	FOREIGNID	FOREIGN_ID_TYPE_A … FOREIGN_ID_TYPE_D

Requirements

• Android 7.0 (API 24) or later
• A camera
• An NFC-capable device for the NFC step
• Internet access

Version

The examples in this documentation are based on rkyc-cnn 2.1.8, id-card-detection-cnn 1.9.9 and passport-reader-cnn 1.1.3.