TRST Docs

Appearance

TRST Android SDK Overview ​

The TRST Device SDK enables Android applications to integrate palm vein biometric authentication and payment processing capabilities. The SDK provides a simple, high-level API for:

  • Device Registration: Register Android devices with the TRST platform using hardware-backed attestation
  • Biometric Enrollment: Enroll users' palm vein biometric data for secure authentication
  • Biometric Identification: Identify users through palm vein scanning

SDK Access ​

The TRST Android SDK is currently in private beta.

To obtain access to the SDK:

Contact: support@trstinc.caSubject: "Android SDK Access Request" Include: Company name, use case description, and contact information

The TRST team will provide SDK packages, documentation, and integration support.

Dual-Purpose Architecture: SDK + Standalone Application ​

This project serves two distinct purposes:

  1. SDK Library (device-sdk module): A lightweight library that customer applications integrate to access biometric authentication capabilities
  2. Standalone Application (ca.trstinc.device): A fully-functional Android app that handles all biometric operations and can be used independently for testing and demonstration

Privacy-First Design: Biometric Data Isolation ​

Critical Security Feature: The TRST Device application is architected to completely isolate customer applications from sensitive biometric data.

  • Biometric data is NEVER shared with customer applications
  • All palm vein capture, processing, and storage occurs exclusively within the TRST Device app
  • Customer applications receive only non-sensitive results: success/failure status, member IDs (if identified), and session states
  • This architecture ensures compliance with biometric privacy regulations and minimizes security risks for integrating applications

Interactive UI Activities ​

The TRST Device app provides rich, interactive Activities that customer applications launch for enrollment and scanning:

  • Real-time visual feedback during biometric capture
  • Palm position guidance to help users position their hands correctly (TOO_CLOSE, TOO_FAR, TOO_LEFT, TOO_RIGHT, GOOD)
  • Quality scoring and progress indicators during enrollment
  • Professional, polished UI that requires zero implementation effort from customer apps

Future Enhancements: These Activities will be expanded to support:

  • Custom branding and color schemes
  • Configurable UI elements and layouts
  • Localization and language customization
  • Accessibility options and alternative feedback modes

Testing and Demonstration ​

The standalone TRST Device application can be used independently to:

  • Test biometric hardware and verify device compatibility
  • Demonstrate palm vein authentication to stakeholders and end users
  • Prototype workflows before full SDK integration
  • Debug integration issues by comparing behavior with the reference implementation

Simply install the app on a compatible device and use the built-in menu to access registration, enrollment, and scanning features.

Key Features ​

  • Hardware-Backed Security: Leverages Android's Trusted Execution Environment (TEE) or StrongBox for attestation
  • Activity Result Contracts: Modern Android integration using ActivityResultContract API
  • Kotlin Coroutines: Async operations using suspend functions
  • Comprehensive Error Handling: Detailed error types for robust error management
  • Long-Polling Support: Built-in polling mechanisms for async operations
  • Zero Biometric Data Exposure: Customer apps never handle raw biometric data

Standalone Application & Testing ​

The TRST Device application (package: ca.trstinc.device) serves dual purposes: it's both a standalone testing/demo tool and the runtime environment for customer app integrations.

Standalone Testing & Demonstration ​

The TRST Device app can be used independently without any SDK integration:

  • Test biometric hardware compatibility on new devices
  • Demonstrate palm vein authentication to stakeholders, customers, or end users
  • Explore the complete workflow (registration → enrollment → scanning) without writing code
  • Validate device attestation and backend connectivity
  • Train staff on the enrollment and scanning processes

Simply install the app and use the built-in menu to access all features. This is particularly useful during:

  • Proof-of-concept phases before committing to integration
  • Hardware evaluation when selecting Android devices
  • User experience testing to gather feedback on biometric workflows

Integration Runtime Environment ​

When customer applications integrate the SDK, the TRST Device app becomes the secure runtime environment that:

  1. Handles all biometric hardware interactions - Palm vein capture device
  2. Provides professional, polished UI - Complete Activities for enrollment and scanning with real-time feedback
  3. Manages sensitive biometric data - All palm vein templates remain isolated within the TRST app
  4. Ensures privacy compliance - Customer apps receive only non-sensitive results (member IDs, success/failure)
  5. Can be launched via Activity Contracts - Modern Android integration using ActivityResultContract

Interactive Activities with Rich Feedback ​

The Activities provided by the TRST Device app include:

  • Device Registration UI: QR code display, expiry countdown, and activation polling
  • Palm Enrollment UI:
    • Two-hand capture workflow (left and right palms)
    • Real-time palm position guidance (TOO_CLOSE, TOO_FAR, GOOD, TOO_LEFT, TOO_RIGHT)
    • Visual hand silhouettes and capture feedback
    • Quality scoring for each captured palm
    • Progress indicators and session state
  • Palm Scanning UI:
    • Biometric capture with positioning guidance
    • Member identification and lookup
    • Success/failure feedback

Upcoming Customization: Future versions will support:

  • Custom branding: Colors, logos, and theme customization
  • UI configuration: Configurable layouts and element visibility
  • Localization: Multi-language support and custom text
  • Accessibility: Alternative feedback modes and enhanced accessibility features

Architecture Benefits ​

Your application integrates with the TRST Device app through the SDK's high-level APIs. You:

  • Don't need to understand the app's internal implementation
  • Don't handle any sensitive biometric data
  • Don't implement complex UI for biometric capture
  • Don't manage hardware drivers or low-level sensor APIs

The TRST Device app handles all complexity, security, and compliance requirements on your behalf.

Next Steps ​

Support ​

For technical support, integration assistance, or to report issues: