SpruceKit Mobile SDK

Learn how to integrate SpruceKit into your new or existing mobile application and unlock trusted data interactions based on open standards!

1. Support Overview

SpruceKit Mobile SDK is under active development, and so are the standards that this open source stack is built on. Support for additional transmission protocols will be added as the need arises.

1.1 Online and Offline Presentation

OID4VP is an online protocol for sharing a verifiable credential. While offline presentation protocols are under development, they have not yet been published. The SpruceKit Mobile SDK, for now, only supports the offline presentation of W3C VCs by embedding the credential in a QR-Code. While this approach can work for JWTs and CWTs, there are limits to how large a credential can get before the QR-Code becomes too large to scan.

Credential format	Online	Offline
W3C VC	✅ Delegated OID4VP	✅ QR embedded only
mDoc	✅ 18013-5	✅ 18013-7

1.2 Mdoc Proximity Engagement Mechanisms

The 18013-5 specification defines three different offline engagement mechanisms. This open-source SDK supports BLE only. Do you have additional needs? Get in contact with our team.

Proximity	Supported	Notes
BLE	✅	Open Source
NFC	❌	Proprietary
Wifi-Aware	❌	Proprietary

2. Licensing

This integration guide will use the SpruceKit Showcase as an example each step along the way. SpruceKit Showcase is an open-source application designed to demonstrate the capabilities of the SpruceKit SDK. We are committed to fostering innovation and collaboration within the developer community by providing this project under dual licensing terms: the MIT License and the Apache License, Version 2.0.

You are welcome to fork and amend the SpruceKit Mobile Showcase application.