
Library suite and tools for issuing, presenting, and verifying mDL/VC credentials using ISO mdoc, SD‑JWT, W3C Digital Credentials, OpenID4VP, and zero-knowledge proof integration.
This repository contains libraries and applications for working with real-world identity. The initial focus for this work was mdoc/mDL according to ISO/IEC 18013-5:2021 and related standards but the current scope also include other credential formats and presentment protocols.
The project provides libraries written in Kotlin Multiplatform:
multipaz provides the core building blocks. It works on Android,
iOS, Linux/JVM, Web, and in server-side environments. The library includes
support for ISO mdoc and IETF SD-JWT VC credential formats, external USB CCID
NFC readers, proximity presentment using ISO/IEC 18013-5:2021 (for ISO mdoc
credentials), and presentment to applications using the W3C Digital
Credentials API according to ISO/IEC 18013-7:2025 and OpenID4VP 1.0.multipaz-compose provides rich UI elements to be used in Compose
Multiplatform applications across Android, iOS, Web, and Desktop JVM.multipaz-facenet provides on-device and server-side
biometric face matching and active liveness verification using MediaPipe BlazeFace
and MobileFaceNet.multipaz-utopia contains document and transaction data types specific
to the Multipaz Utopia universe.multipaz-doctypes contains standardized document and transaction data
types (including ISO/IEC 18013-5:2021 mDL and EU PID) along with human-readable
descriptions of claims / data elements, sample data, and sample requests.multipaz-longfellow bundles the Google Longfellow-ZK library
and integrates with the core multipaz for Zero-Knowledge Proofs
according to latest available ISO/IEC 18013-5 Second Edition draft.multipaz-swiftui contains SwiftUI components which can be used in
Swift applications.multipaz-nci implements the NFC Forum NFC Controller Interface (NCI) 2.0
protocol for both NFC reader/writer (NfcTagReader) and NFC card emulation
(NfcApduRouter) over a transport-agnostic NciPacketIo interface,
including a Linux I2C + GPIO transport (LinuxI2cNciPacketIo, e.g., for NXP
PN7160 controllers on Raspberry Pi and embedded Linux systems).multipaz-bthci implements a user-space Bluetooth Low Energy HCI, L2CAP
(including LE Credit-Based Flow Control Mode), and ATT/GATT stack backing
Multipaz's ISO/IEC 18013-5 BLE central and peripheral proximity transports
over a transport-agnostic HciPacketIo interface, including direct Linux
AF_BLUETOOTH / HCI_CHANNEL_USER socket support (LinuxHciSocketPacketIo).A command-line tool multipazctl is also included which can be used to generate
ISO/IEC 18013-5:2021 IACA certificates among other things. Use
./gradlew --quiet runMultipazCtl --args "help" for documentation on supported
verbs and options. To set up a wrapper, first build the fat jar
$ ./gradlew multipazctl:buildFatJarthen create a wrapper like this
#!/bin/sh
MAIN_CLASS="org.multipaz.multipazctl.MultipazCtl"
CLASSPATH="/Users/davidz/StudioProjects/identity-credential/multipazctl/build/libs/multipazctl-all.jar"
JVM_OPTS="-Xms256m -Xmx512m"
exec java $JVM_OPTS -cp "$CLASSPATH" "$MAIN_CLASS" "$@"in e.g. ~/bin/multipazctl adjusting paths as needed. With this you can now
invoke multipazctl like any other system tool.
Libraries are released on Maven Central usually every 4-8 weeks. Releases up until and including 0.97.0 can be found on GMaven. Semantic Versioning is used. At this time we're in pre-1.0 territory but we expect to hit 1.0 around late 2026 or early 2027.
At this point both API interfaces and data stored on disk are subject to change
but we expect to provide stability guarantees post 1.0. We only expect minor changes
for example conversion from ByteArray to ByteString and similar things.
Multipaz is published as Kotlin Multiplatform libraries rather than a pre-packaged Swift package or standalone XCFramework. Consuming iOS and Swift projects are better off building the XCFramework themselves using Gradle for several key reasons:
To see how to structure this in practice, see the shared module in the
Multipaz Wallet repository.
The shared module includes the Multipaz dependencies via Gradle, incorporates
wallet-specific Kotlin code, configures SKIE, and builds a single unified XCFramework
that the iOS application links against.
Snapshot builds of the latest development version are automatically published to the Sonatype Central Snapshots repository on every push to the main branch.
To use snapshot builds in a project consuming Multipaz:
Add the Sonatype Snapshots repository to your project's settings.gradle.kts file:
dependencyResolutionManagement {
repositories {
google()
mavenCentral()
maven {
url = uri("https://central.sonatype.com/repository/maven-snapshots/")
}
}
}Reference the snapshot version of the library in your module's build.gradle.kts dependencies block. For example if the latest release version is 0.99.0 you can consume snapshots leading up to the next release in the following way:
dependencies {
implementation("org.multipaz:multipaz:0.100.0-SNAPSHOT")
}[!TIP] By default, Gradle caches snapshots for 24 hours. To force Gradle to check for and download the latest snapshot immediately when doing a project sync, add the following to your top-level
build.gradle.kts:subprojects { configurations.all { resolutionStrategy.cacheChangingModulesFor(0, "seconds") } }Alternatively, you can run Gradle with the
--refresh-dependenciesflag (e.g.,./gradlew build --refresh-dependencies) to update cached snapshots on demand.
This project uses Kotlin Multiplatform (KMP) JS and Wasm targets. NPM dependency versions are pinned in kotlin-js-store/yarn.lock and kotlin-js-store/wasm/yarn.lock to ensure build reproducibility.
To upgrade the locked package versions (e.g., to address Dependabot vulnerability alerts):
Clean intermediate Gradle build artifacts:
$ ./gradlew cleanGenerate the initial NPM workspaces:
$ ./gradlew kotlinUpgradeYarnLock kotlinWasmUpgradeYarnLockUpgrade npm package versions using Yarn:
$ cd build/js && npx yarn upgrade
$ cd ../wasm && npx yarn upgrade
$ cd ../..Persist the updated lockfiles to the repository store:
$ ./gradlew kotlinUpgradeYarnLock kotlinWasmUpgradeYarnLock -x kotlinRestoreYarnLock -x kotlinWasmRestoreYarnLockModules that localize strings (multipaz-doctypes and multipaz-utopia) keep their string resources as JSON under src/commonMain/lokalize/, and the Kotlin rendered from them is checked into the tree under src/commonMain/generated/ so the source compiles as-is on non-Gradle build systems.
Because those Kotlin files are committed rather than regenerated on every build, after adding or editing strings you must regenerate and commit them:
Regenerate the Kotlin sources for the affected module:
$ ./gradlew :multipaz-doctypes:generateMultipazStrings
$ ./gradlew :multipaz-utopia:generateMultipazStringsCommit the regenerated files under src/commonMain/generated/ together with the strings.json changes.
lokalizeCheckGenerated runs as part of ./gradlew check (and CI) and fails the build if the committed sources drift from the JSON resources, printing the exact command to run.
We have resources for people already involved and people wishing to contribute to the Multipaz project
multipaz-compose, multipaz-doctypes, and multipaz-utopia (AI-assisted translation and validation).Note: If you're just looking to use the Multipaz libraries you do not need to build the entire Multipaz project from source. Instead, just use our released libraries, see the next section for an example of this.
For a fully-fledged mDL wallet and testbed, our current answer is to use the
samples/testapp module which works on Android, iOS, and Linux (Compose Desktop
JVM). This application is intended for developers and as such has a lot of
options and settings. It's intended to exercise all code in the libraries.
Prebuilt Android APKs are available from https://apps.multipaz.org.
samples/testapp can run on Linux (including embedded Linux systems such as
Raspberry Pi) using Compose Desktop JVM, with support for direct Bluetooth Low
Energy (multipaz-bthci), external USB CCID NFC readers (libusb-1.0), and
I2C + GPIO NCI 2.0 NFC controllers such as the NXP PN7160 (multipaz-nci).
Credentials and settings are stored under $XDG_DATA_HOME/multipaz (or
~/.local/share/multipaz).
System packages (Debian / Ubuntu / Raspberry Pi OS):
$ sudo apt install libusb-1.0-0 libcap2-binlibusb-1.0-0 is used to access external USB CCID NFC readers. If pcscd
is installed and claims the reader exclusively, stop it first
(sudo systemctl stop pcscd.socket pcscd.service); you can then grant
per-user ACL access from the USB NFC Readers screen in the app.libcap2-bin provides /usr/sbin/capsh, used by the HCI launcher script
below.Launching without direct Bluetooth HCI access:
$ ./gradlew :samples:testapp:run -Pdisable.web.targets=trueLaunching with Bluetooth Low Energy (HCI_CHANNEL_USER):
Direct HCI access via LinuxHciSocketPacketIo binds exclusively to a kernel
Bluetooth controller (hci0, hci1, etc.) and requires CAP_NET_ADMIN (the
kernel temporarily detaches BlueZ bluetoothd from that controller while the
socket is open). Use utils/launch-samples-testapp-with-hci,
which builds unprivileged as your normal user and uses sudo + capsh to
drop back to your user with only ambient CAP_NET_ADMIN:
$ ./utils/launch-samples-testapp-with-hci --help
$ ./utils/launch-samples-testapp-with-hci hci0Using an I2C + GPIO NCI 2.0 NFC controller (e.g., NXP PN7160):
Ensure your user belongs to the i2c and gpio groups so /dev/i2c-* and
/dev/gpiochip* are accessible. You can configure and enable the controller
either in Settings -> Enable NCI NFC Controller (Linux I2C + GPIO) in the
UI, or transiently for a single run via environment variables:
$ MULTIPAZ_NFC_ENABLED=1 \
MULTIPAZ_NFC_I2C_DEV=/dev/i2c-1 \
MULTIPAZ_NFC_I2C_ADDR=0x28 \
MULTIPAZ_NFC_GPIO_CHIP=/dev/gpiochip0 \
MULTIPAZ_NFC_IRQ_PIN=23 \
MULTIPAZ_NFC_VEN_PIN=24 \
./utils/launch-samples-testapp-with-hci hci0Set MULTIPAZ_DEBUG=1 to enable verbose debug logging.
For a SwiftUI version of samples/testapp see samples/SwiftTestApp which works
on iOS and is a testbed for the Swift bindings as well as the SwiftUI components
in multipaz-swiftui.
For a fully-featured proximity reader app using Multipaz, see MpzIdentityReader. Prebuilt APKs are available from https://apps.multipaz.org.
For an over-the-Internet verifier supporting OpenID4VP (both W3C DC API and URI schemes) and ISO/IEC 18013-7 Annex A and C see https://verifier.multipaz.org.
To see how to use Multipaz in a 3rd party project, see https://github.com/openwallet-foundation/multipaz-samples/ which includes a number of samples for different platforms.
developer.multipaz.org is a comprehensive resource for developers. The entire developer website is open source and contributions are welcome!
This is not an official or supported Google product.
This repository contains libraries and applications for working with real-world identity. The initial focus for this work was mdoc/mDL according to ISO/IEC 18013-5:2021 and related standards but the current scope also include other credential formats and presentment protocols.
The project provides libraries written in Kotlin Multiplatform:
multipaz provides the core building blocks. It works on Android,
iOS, Linux/JVM, Web, and in server-side environments. The library includes
support for ISO mdoc and IETF SD-JWT VC credential formats, external USB CCID
NFC readers, proximity presentment using ISO/IEC 18013-5:2021 (for ISO mdoc
credentials), and presentment to applications using the W3C Digital
Credentials API according to ISO/IEC 18013-7:2025 and OpenID4VP 1.0.multipaz-compose provides rich UI elements to be used in Compose
Multiplatform applications across Android, iOS, Web, and Desktop JVM.multipaz-facenet provides on-device and server-side
biometric face matching and active liveness verification using MediaPipe BlazeFace
and MobileFaceNet.multipaz-utopia contains document and transaction data types specific
to the Multipaz Utopia universe.multipaz-doctypes contains standardized document and transaction data
types (including ISO/IEC 18013-5:2021 mDL and EU PID) along with human-readable
descriptions of claims / data elements, sample data, and sample requests.multipaz-longfellow bundles the Google Longfellow-ZK library
and integrates with the core multipaz for Zero-Knowledge Proofs
according to latest available ISO/IEC 18013-5 Second Edition draft.multipaz-swiftui contains SwiftUI components which can be used in
Swift applications.multipaz-nci implements the NFC Forum NFC Controller Interface (NCI) 2.0
protocol for both NFC reader/writer (NfcTagReader) and NFC card emulation
(NfcApduRouter) over a transport-agnostic NciPacketIo interface,
including a Linux I2C + GPIO transport (LinuxI2cNciPacketIo, e.g., for NXP
PN7160 controllers on Raspberry Pi and embedded Linux systems).multipaz-bthci implements a user-space Bluetooth Low Energy HCI, L2CAP
(including LE Credit-Based Flow Control Mode), and ATT/GATT stack backing
Multipaz's ISO/IEC 18013-5 BLE central and peripheral proximity transports
over a transport-agnostic HciPacketIo interface, including direct Linux
AF_BLUETOOTH / HCI_CHANNEL_USER socket support (LinuxHciSocketPacketIo).A command-line tool multipazctl is also included which can be used to generate
ISO/IEC 18013-5:2021 IACA certificates among other things. Use
./gradlew --quiet runMultipazCtl --args "help" for documentation on supported
verbs and options. To set up a wrapper, first build the fat jar
$ ./gradlew multipazctl:buildFatJarthen create a wrapper like this
#!/bin/sh
MAIN_CLASS="org.multipaz.multipazctl.MultipazCtl"
CLASSPATH="/Users/davidz/StudioProjects/identity-credential/multipazctl/build/libs/multipazctl-all.jar"
JVM_OPTS="-Xms256m -Xmx512m"
exec java $JVM_OPTS -cp "$CLASSPATH" "$MAIN_CLASS" "$@"in e.g. ~/bin/multipazctl adjusting paths as needed. With this you can now
invoke multipazctl like any other system tool.
Libraries are released on Maven Central usually every 4-8 weeks. Releases up until and including 0.97.0 can be found on GMaven. Semantic Versioning is used. At this time we're in pre-1.0 territory but we expect to hit 1.0 around late 2026 or early 2027.
At this point both API interfaces and data stored on disk are subject to change
but we expect to provide stability guarantees post 1.0. We only expect minor changes
for example conversion from ByteArray to ByteString and similar things.
Multipaz is published as Kotlin Multiplatform libraries rather than a pre-packaged Swift package or standalone XCFramework. Consuming iOS and Swift projects are better off building the XCFramework themselves using Gradle for several key reasons:
To see how to structure this in practice, see the shared module in the
Multipaz Wallet repository.
The shared module includes the Multipaz dependencies via Gradle, incorporates
wallet-specific Kotlin code, configures SKIE, and builds a single unified XCFramework
that the iOS application links against.
Snapshot builds of the latest development version are automatically published to the Sonatype Central Snapshots repository on every push to the main branch.
To use snapshot builds in a project consuming Multipaz:
Add the Sonatype Snapshots repository to your project's settings.gradle.kts file:
dependencyResolutionManagement {
repositories {
google()
mavenCentral()
maven {
url = uri("https://central.sonatype.com/repository/maven-snapshots/")
}
}
}Reference the snapshot version of the library in your module's build.gradle.kts dependencies block. For example if the latest release version is 0.99.0 you can consume snapshots leading up to the next release in the following way:
dependencies {
implementation("org.multipaz:multipaz:0.100.0-SNAPSHOT")
}[!TIP] By default, Gradle caches snapshots for 24 hours. To force Gradle to check for and download the latest snapshot immediately when doing a project sync, add the following to your top-level
build.gradle.kts:subprojects { configurations.all { resolutionStrategy.cacheChangingModulesFor(0, "seconds") } }Alternatively, you can run Gradle with the
--refresh-dependenciesflag (e.g.,./gradlew build --refresh-dependencies) to update cached snapshots on demand.
This project uses Kotlin Multiplatform (KMP) JS and Wasm targets. NPM dependency versions are pinned in kotlin-js-store/yarn.lock and kotlin-js-store/wasm/yarn.lock to ensure build reproducibility.
To upgrade the locked package versions (e.g., to address Dependabot vulnerability alerts):
Clean intermediate Gradle build artifacts:
$ ./gradlew cleanGenerate the initial NPM workspaces:
$ ./gradlew kotlinUpgradeYarnLock kotlinWasmUpgradeYarnLockUpgrade npm package versions using Yarn:
$ cd build/js && npx yarn upgrade
$ cd ../wasm && npx yarn upgrade
$ cd ../..Persist the updated lockfiles to the repository store:
$ ./gradlew kotlinUpgradeYarnLock kotlinWasmUpgradeYarnLock -x kotlinRestoreYarnLock -x kotlinWasmRestoreYarnLockModules that localize strings (multipaz-doctypes and multipaz-utopia) keep their string resources as JSON under src/commonMain/lokalize/, and the Kotlin rendered from them is checked into the tree under src/commonMain/generated/ so the source compiles as-is on non-Gradle build systems.
Because those Kotlin files are committed rather than regenerated on every build, after adding or editing strings you must regenerate and commit them:
Regenerate the Kotlin sources for the affected module:
$ ./gradlew :multipaz-doctypes:generateMultipazStrings
$ ./gradlew :multipaz-utopia:generateMultipazStringsCommit the regenerated files under src/commonMain/generated/ together with the strings.json changes.
lokalizeCheckGenerated runs as part of ./gradlew check (and CI) and fails the build if the committed sources drift from the JSON resources, printing the exact command to run.
We have resources for people already involved and people wishing to contribute to the Multipaz project
multipaz-compose, multipaz-doctypes, and multipaz-utopia (AI-assisted translation and validation).Note: If you're just looking to use the Multipaz libraries you do not need to build the entire Multipaz project from source. Instead, just use our released libraries, see the next section for an example of this.
For a fully-fledged mDL wallet and testbed, our current answer is to use the
samples/testapp module which works on Android, iOS, and Linux (Compose Desktop
JVM). This application is intended for developers and as such has a lot of
options and settings. It's intended to exercise all code in the libraries.
Prebuilt Android APKs are available from https://apps.multipaz.org.
samples/testapp can run on Linux (including embedded Linux systems such as
Raspberry Pi) using Compose Desktop JVM, with support for direct Bluetooth Low
Energy (multipaz-bthci), external USB CCID NFC readers (libusb-1.0), and
I2C + GPIO NCI 2.0 NFC controllers such as the NXP PN7160 (multipaz-nci).
Credentials and settings are stored under $XDG_DATA_HOME/multipaz (or
~/.local/share/multipaz).
System packages (Debian / Ubuntu / Raspberry Pi OS):
$ sudo apt install libusb-1.0-0 libcap2-binlibusb-1.0-0 is used to access external USB CCID NFC readers. If pcscd
is installed and claims the reader exclusively, stop it first
(sudo systemctl stop pcscd.socket pcscd.service); you can then grant
per-user ACL access from the USB NFC Readers screen in the app.libcap2-bin provides /usr/sbin/capsh, used by the HCI launcher script
below.Launching without direct Bluetooth HCI access:
$ ./gradlew :samples:testapp:run -Pdisable.web.targets=trueLaunching with Bluetooth Low Energy (HCI_CHANNEL_USER):
Direct HCI access via LinuxHciSocketPacketIo binds exclusively to a kernel
Bluetooth controller (hci0, hci1, etc.) and requires CAP_NET_ADMIN (the
kernel temporarily detaches BlueZ bluetoothd from that controller while the
socket is open). Use utils/launch-samples-testapp-with-hci,
which builds unprivileged as your normal user and uses sudo + capsh to
drop back to your user with only ambient CAP_NET_ADMIN:
$ ./utils/launch-samples-testapp-with-hci --help
$ ./utils/launch-samples-testapp-with-hci hci0Using an I2C + GPIO NCI 2.0 NFC controller (e.g., NXP PN7160):
Ensure your user belongs to the i2c and gpio groups so /dev/i2c-* and
/dev/gpiochip* are accessible. You can configure and enable the controller
either in Settings -> Enable NCI NFC Controller (Linux I2C + GPIO) in the
UI, or transiently for a single run via environment variables:
$ MULTIPAZ_NFC_ENABLED=1 \
MULTIPAZ_NFC_I2C_DEV=/dev/i2c-1 \
MULTIPAZ_NFC_I2C_ADDR=0x28 \
MULTIPAZ_NFC_GPIO_CHIP=/dev/gpiochip0 \
MULTIPAZ_NFC_IRQ_PIN=23 \
MULTIPAZ_NFC_VEN_PIN=24 \
./utils/launch-samples-testapp-with-hci hci0Set MULTIPAZ_DEBUG=1 to enable verbose debug logging.
For a SwiftUI version of samples/testapp see samples/SwiftTestApp which works
on iOS and is a testbed for the Swift bindings as well as the SwiftUI components
in multipaz-swiftui.
For a fully-featured proximity reader app using Multipaz, see MpzIdentityReader. Prebuilt APKs are available from https://apps.multipaz.org.
For an over-the-Internet verifier supporting OpenID4VP (both W3C DC API and URI schemes) and ISO/IEC 18013-7 Annex A and C see https://verifier.multipaz.org.
To see how to use Multipaz in a 3rd party project, see https://github.com/openwallet-foundation/multipaz-samples/ which includes a number of samples for different platforms.
developer.multipaz.org is a comprehensive resource for developers. The entire developer website is open source and contributions are welcome!
This is not an official or supported Google product.