Wink Identity SDK

Android

Drop biometric enrollment and recognition into a native Android app. Ships an embedded UI for face / voice / palm / WinkPIN capture, plus a Kotlin coroutine API for the orchestration around it.

Package WinkIdentitySDK Distribution Azure DevOps Min SDK 26 Environment stage

Get the SDK

The Wink Identity SDK for Android is distributed from a public Azure DevOps git repository. Accept the Wink Evaluation License (once per account) to unlock the clone URL below.

Latest main

Track main for the current build. Tags will be added as the release cadence stabilises — pin to a commit SHA in the meantime for reproducible builds.

git clone https://dev.azure.com/payfave/wink-payfave-public/_git/wink_mobile_sdk_android

OR Click here for detailed reference documentation, sample code and SDK download from Wink DevOps ↗

Detailed docs are still coming. The steps below describe the shape of an integration; the repo's README.md is the authoritative reference for the current SDK version — module name, entry-point class, and Gradle wiring can shift between builds until the SDK cuts its first tagged release.

Install

Clone the SDK repo alongside your app and include it as a local Gradle module.

1. Clone alongside your app

          shell
          your-app/
        

git clone https://dev.azure.com/payfave/wink-payfave-public/_git/wink_mobile_sdk_android wink-sdk

2. Include the module in `settings.gradle.kts`

          Kotlin DSL
          settings.gradle.kts
        

include(":app", ":wink-sdk")
project(":wink-sdk").projectDir = file("../wink-sdk/<module-name>")

Replace <module-name> with the SDK's library module name — see the repo README.

3. Depend on it from your app

          Kotlin DSL
          app/build.gradle.kts
        

dependencies {
  implementation(project(":wink-sdk"))
}

4. Bundle the merchant signing key

Wink issues you a private PEM when you provision a merchant. Drop it into app/src/main/assets/wink_private_key.pem and add it to .gitignore immediately — it's a per-merchant secret.

Configure

Configure the SDK once at app launch — typically inside your Application.onCreate(). The SDK keeps a singleton, so a single configure call is enough for the lifetime of the process.

The exact configuration API (class names, builder shape) is subject to change ahead of the first tagged release. Refer to the repo README's Configuration section for the current call sites; the iOS SDK's Configure section documents the same fields conceptually (keyId, merchantId, mfaOrder, environment).

Next steps

Skim the repo README — it has the current module layout and any breaking-change notes.
Reference the iOS SDK page for the conceptual model: enroll vs authenticate, WinkLoginSnapshot fields, Yellow/Green response semantics. The Android surface mirrors iOS closely.
Prototype with the Core API console if you'd like to poke the underlying REST surface before wiring native.

Reporting bugs: the WinkKey Android team is the upstream channel for SDK feedback while the public tracker is being stood up. File issues via your Wink onboarding contact with reproduction steps; the Wink mobile team triages weekly.